-
Notifications
You must be signed in to change notification settings - Fork 755
/
Copy pathfinances_2024-06-19.json
866 lines (866 loc) · 28.6 KB
/
finances_2024-06-19.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
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.",
"version": "2024-06-19",
"title": "The Selling Partner API for Finances",
"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": {
"/finances/2024-06-19/transactions": {
"get": {
"description": "Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.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 than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "listTransactions",
"parameters": [
{
"name": "postedAfter",
"in": "query",
"description": "A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.",
"required": true,
"type": "string",
"format": "date-time",
"x-example": "2023-01-12"
},
{
"name": "postedBefore",
"in": "query",
"description": "A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.",
"required": false,
"type": "string",
"format": "date-time",
"x-example": "2023-02-12"
},
{
"name": "marketplaceId",
"in": "query",
"description": "A string token used to select Marketplace ID.",
"required": false,
"type": "string",
"x-example": "ATIV93840DER"
},
{
"name": "nextToken",
"in": "query",
"description": "A string token returned in the response of your previous request.",
"required": false,
"type": "string",
"x-example": "jehgri34yo7jr9e8f984tr9i4o"
}
],
"responses": {
"200": {
"description": "Success.",
"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"
}
},
"schema": {
"$ref": "#/definitions/ListTransactionsResponse"
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"postedAfter": {
"value": "2023-03-07"
},
"nextToken": {
"value": "jehgri34yo7jr9e8f984tr9i4o"
}
}
},
"response": {
"nextToken": "Next token value",
"transactions": [
{
"sellingPartnerMetadata": {
"sellingPartnerId": "A3TH9S8BH6GOGM",
"accountType": "PAYABLE",
"marketplaceId": "ATIV93840DER"
},
"relatedIdentifiers": [
{
"relatedIdentifierName": "ORDER_ID",
"relatedIdentifierValue": "8129762527551"
}
],
"transactionType": "Shipment",
"postedDate": "2020-07-14T03:35:13.214Z",
"totalAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
}
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"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"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"postedBefore": {
"value": "2022-03-07"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Start date cannot be null",
"details": "Start date cannot be null"
}
]
}
}
]
}
},
"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": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"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."
}
}
},
"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"
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"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/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"ListTransactionsResponse": {
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
},
"transactions": {
"$ref": "#/definitions/Transactions"
}
},
"description": "The Response schema."
},
"Transactions": {
"type": "array",
"description": "Contains transactions within a given time period.",
"items": {
"$ref": "#/definitions/Transaction"
}
},
"Transaction": {
"type": "object",
"properties": {
"sellingPartnerMetadata": {
"description": "Metadata describing the seller.",
"$ref": "#/definitions/SellingPartnerMetadata"
},
"relatedIdentifiers": {
"description": "Related business identifiers of the transaction.",
"$ref": "#/definitions/RelatedIdentifiers"
},
"transactionType": {
"type": "string",
"description": "The type of transaction.\n\nPossible values:\n\n* Shipment"
},
"transactionId": {
"type": "string",
"description": "The unique identifier for the transaction."
},
"transactionStatus": {
"type": "string",
"description": "The status for the transaction. \n\nPossible values:\n\n* Deferred *Released"
},
"description": {
"type": "string",
"description": "Describes the reasons for the transaction.\n\nExample: 'Order Payment','Refund Order'"
},
"postedDate": {
"description": "The date and time when the transaction was posted.",
"$ref": "#/definitions/Date"
},
"totalAmount": {
"description": "Total amount of transaction.",
"$ref": "#/definitions/Currency"
},
"marketplaceDetails": {
"description": "Information about the marketplace where the transaction occurred.",
"$ref": "#/definitions/MarketplaceDetails"
},
"items": {
"description": "Additional information about the items in Transaction.",
"$ref": "#/definitions/Items"
},
"contexts": {
"description": "Additional Information about the transaction.",
"$ref": "#/definitions/Contexts"
},
"breakdowns": {
"description": "List of breakdowns which will provide the details on how the total amount is calculated for the financial transaction.",
"$ref": "#/definitions/Breakdowns"
}
},
"description": "Contains all information related to the transaction.",
"example": {
"sellingPartnerMetadata": {
"sellingPartnerId": "XXXXXXXXXXXXXX",
"accountType": "PAYABLE",
"marketplaceId": "ATVPDKIKX0DER"
},
"relatedIdentifiers": [
{
"relatedIdentifierName": "ORDER_ID",
"relatedIdentifierValue": "8129762527551"
}
],
"transactionType": "Shipment",
"transactionId": "b1qD0oAliFkLiqRyGbmeT0DoS2Z2kHzi7TZ92z-vARI",
"transactionStatus": "Released",
"description": "Order Payment",
"postedDate": "2020-07-14T03:35:13.214Z",
"totalAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"marketplaceDetails": {
"marketplaceId": "ATVPDKIKX0DER",
"marketplaceName": "Amazon.com"
},
"items": [
{
"description": "Item title",
"totalAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"relatedIdentifiers": [
{
"itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
"itemRelatedIdentifierValue": "81297625-121-27551"
}
],
"breakdowns": [
{
"breakdownType": "Product Charges",
"breakdownAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"breakdowns": [
{
"breakdownType": "Principle",
"breakdownAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"breakdowns": []
}
]
}
],
"contexts": [
{
"contextType": "ProductContext",
"asin": "B07FGXZQZ1",
"sku": "sku-12",
"quantityShipped": 1,
"fulfillmentNetwork": "MFN"
}
]
}
],
"breakdowns": {
"breakdowns": [
{
"breakdownType": "Sales",
"breakdownAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"breakdowns": [
{
"breakdownType": "Product Charges",
"breakdownAmount": {
"currencyAmount": 10,
"currencyCode": "USD"
},
"breakdowns": []
}
]
}
]
},
"contexts": [
{
"contextType": "AmazonPayContext",
"storeName": "Store 1",
"orderType": "Order Type",
"channel": "MFN"
}
]
}
},
"BigDecimal": {
"type": "number",
"description": "Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount)."
},
"Currency": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "The three-digit currency code in ISO 4217 format."
},
"currencyAmount": {
"description": "The monetary value.",
"$ref": "#/definitions/BigDecimal"
}
},
"description": "A currency type and amount."
},
"SellingPartnerMetadata": {
"type": "object",
"properties": {
"sellingPartnerId": {
"type": "string",
"description": "Unique seller identifier."
},
"accountType": {
"type": "string",
"description": "Account type of transaction."
},
"marketplaceId": {
"type": "string",
"description": "Marketplace identifier of transaction."
}
},
"description": "Metadata describing the seller."
},
"RelatedIdentifier": {
"type": "object",
"properties": {
"relatedIdentifierName": {
"type": "string",
"description": "Enumerated set of related business identifier names.",
"enum": [
"ORDER_ID",
"SHIPMENT_ID",
"EVENT_GROUP_ID",
"REFUND_ID",
"INVOICE_ID",
"DISBURSEMENT_ID",
"TRANSFER_ID"
],
"x-docgen-enum-table-extension": [
{
"value": "ORDER_ID",
"description": "Associated OrderId of transaction"
},
{
"value": "SHIPMENT_ID",
"description": "Associated ShipmentId of transaction"
},
{
"value": "EVENT_GROUP_ID",
"description": "Associated identifier of the transaction's financial event group."
},
{
"value": "REFUND_ID",
"description": "Associated RefundId of transaction"
},
{
"value": "INVOICE_ID",
"description": "Associated InvoiceId of transaction"
},
{
"value": "DISBURSEMENT_ID",
"description": "Disbursement Id for Amazon's bank transfer."
},
{
"value": "TRANSFER_ID",
"description": "Associated TransferId of transaction"
}
]
},
"relatedIdentifierValue": {
"type": "string",
"description": "Corresponding value of RelatedIdentifierName"
}
},
"description": "Related business identifier of the transaction."
},
"RelatedIdentifiers": {
"type": "array",
"description": "Related business identifiers of the transaction.",
"items": {
"$ref": "#/definitions/RelatedIdentifier"
}
},
"Date": {
"type": "string",
"format": "date-time",
"description": "Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate)."
},
"MarketplaceDetails": {
"type": "object",
"properties": {
"marketplaceId": {
"type": "string",
"description": "The identifier of the marketplace where the transaction was made."
},
"marketplaceName": {
"type": "string",
"description": "The name of the marketplace where the transaction occurred. \n\nExample: 'Amazon.com','Amazon.in'"
}
},
"description": "Information about the marketplace where the transaction occurred.",
"example": {
"marketplaceId": "ATVPDKIKX0DER",
"marketplaceName": "Amazon.com"
}
},
"Items": {
"type": "array",
"description": "List of items in the transaction",
"items": {
"$ref": "#/definitions/Item"
}
},
"Item": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of items in the transaction"
},
"relatedIdentifiers": {
"description": "Related business identifiers of the item.",
"$ref": "#/definitions/ItemRelatedIdentifiers"
},
"totalAmount": {
"description": "The total amount of the item.",
"$ref": "#/definitions/Currency"
},
"breakdowns": {
"description": "List of breakdowns which will provide the details on how the total amount is calculated for the financial transaction.",
"$ref": "#/definitions/Breakdowns"
},
"contexts": {
"description": "Additional Information about the item.",
"$ref": "#/definitions/Contexts"
}
},
"description": "Additional information about the items in Transaction."
},
"ItemRelatedIdentifier": {
"type": "object",
"properties": {
"itemRelatedIdentifierName": {
"type": "string",
"description": "Enumerated set of related item identifier names for the item.",
"enum": [
"ORDER_ADJUSTMENT_ITEM_ID",
"COUPON_ID",
"REMOVAL_SHIPMENT_ITEM_ID",
"TRANSACTION_ID"
],
"x-docgen-enum-table-extension": [
{
"value": "ORDER_ADJUSTMENT_ITEM_ID",
"description": "An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events."
},
{
"value": "COUPON_ID",
"description": "An identifier for Coupon applied on transaction."
},
{
"value": "REMOVAL_SHIPMENT_ITEM_ID",
"description": "An identifier for an item in a removal shipment."
},
{
"value": "TRANSACTION_ID",
"description": "Transaction id for the item."
}
]
},
"itemRelatedIdentifierValue": {
"type": "string",
"description": "Corresponding value of ItemRelatedIdentifierName"
}
},
"description": "Related business identifiers of the item.",
"example": {
"itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
"itemRelatedIdentifierValue": "OAI-123456789"
}
},
"ItemRelatedIdentifiers": {
"type": "array",
"description": "Related Business identifiers of the item in Transaction.",
"items": {
"$ref": "#/definitions/ItemRelatedIdentifier"
}
},
"Breakdowns": {
"type": "array",
"description": "List of breakdowns which will provide the details on how the total amount is calculated for the financial transaction.",
"items": {
"$ref": "#/definitions/Breakdown"
}
},
"Breakdown": {
"type": "object",
"properties": {
"breakdownType": {
"type": "string",
"description": "The type of charge."
},
"breakdownAmount": {
"description": "The amount of the charge.",
"$ref": "#/definitions/Currency"
},
"breakdowns": {
"description": "Further granular breakdowns of the BreakdownType.",
"$ref": "#/definitions/Breakdown"
}
},
"description": "Breakdown provides details regarding the money movement under the financial transaction. Breakdowns get categorized further into breakdown types, breakdown amounts, and further breakdowns into a hierarchical structure."
},
"Contexts": {
"type": "array",
"description": "List of additional Information about the item.",
"items": {
"$ref": "#/definitions/Context"
}
},
"Context": {
"description": "Additional Information about the item.",
"allOf": [
{
"type": "object",
"required": [
"contextType"
],
"properties": {
"contextType": {
"type": "string"
}
}
},
{
"$ref": "#/definitions/AmazonPayContext"
},
{
"$ref": "#/definitions/ProductContext"
},
{
"$ref": "#/definitions/PaymentsContext"
},
{
"$ref": "#/definitions/DeferredContext"
},
{
"$ref": "#/definitions/TimeRangeContext"
}
],
"x-example": [
{
"contextType": "ProductContext",
"asin": "B07FGXZQZ1",
"sku": "sku-12",
"quantityShipped": 1,
"fulfillmentNetwork": "MFN"
},
{
"contextType": "AmazonPayContext",
"storeName": "Store 1",
"orderType": "Order Type",
"channel": "MFN"
}
]
},
"ProductContext": {
"description": "Additional information related to the product.",
"type": "object",
"properties": {
"asin": {
"type": "string",
"description": "Amazon Standard Identification Number (ASIN) of the item."
},
"sku": {
"type": "string",
"description": "Stock keeping unit (SKU) of the item."
},
"quantityShipped": {
"type": "integer",
"format": "int32",
"description": "Quantity of the item shipped."
},
"fulfillmentNetwork": {
"type": "string",
"description": "Fulfillment network of the item."
}
},
"example": {
"asin": "B07FGXZQZ1",
"sku": "sku-12",
"quantityShipped": 1,
"fulfillmentNetwork": "MFN"
}
},
"AmazonPayContext": {
"description": "Additional information related to Amazon Pay.",
"type": "object",
"properties": {
"storeName": {
"type": "string",
"description": "Store name related to transaction."
},
"orderType": {
"type": "string",
"description": "Order type of the transaction."
},
"channel": {
"type": "string",
"description": "Channel details of related transaction."
}
},
"example": {
"storeName": "Store 1",
"orderType": "Order Type",
"channel": "MFN"
}
},
"PaymentsContext": {
"description": "Additional information related to Payments related transactions.",
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"description": "Type of payment made."
},
"paymentMethod": {
"type": "string",
"description": "Method of payment made."
},
"paymentReference": {
"type": "string",
"description": "Reference number of payment made."
},
"paymentDate": {
"$ref": "#/definitions/Date",
"description": "Date of payment made."
}
},
"example": {
"paymentType": "Debit Card",
"paymentMethod": "BANK",
"paymentReference": "XXXXX123",
"paymentDate": "2020-07-14T03:35:13.214Z"
}
},
"DeferredContext": {
"description": "Additional information related to Deferred transactions.",
"type": "object",
"properties": {
"deferralReason": {
"type": "string",
"description": "Deferral policy applied on the transaction.\n\nExample: 'B2B','DD7'"
},
"maturityDate": {
"$ref": "#/definitions/Date",
"description": "Release Date of the transaction."
},
"deferralStatus": {
"type": "string",
"description": "Status of the transaction. \n\nExample: 'HOLD','RELEASE'"
}
},
"example": {
"deferralReason": "B2B",
"maturityDate": "2024-07-14T00:00:00Z",
"deferralStatus": "HOLD"
}
},
"TimeRangeContext": {
"description": "Additional information related to time range for transaction.",
"type": "object",
"properties": {
"startTime": {
"$ref": "#/definitions/Date",
"description": "Start time of the transaction."
},
"endTime": {
"$ref": "#/definitions/Date",
"description": "End time of the transaction."
}
},
"example": {
"startTime": "2020-07-14T03:35:13.214Z",
"endTime": "2020-07-14T03:35:13.214Z"
}
},
"ErrorList": {
"type": "object",
"description": "A list of error responses returned when a request is unsuccessful.",
"required": [
"errors"
],
"properties": {
"errors": {
"description": "Error response returned when the request is unsuccessful.",
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
}
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"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."
},
"details": {
"type": "string",
"description": "Additional details that can help the caller understand or fix the issue."
}
},
"description": "Error response returned when the request is unsuccessful."
}
}
}