Make GetFulfillmentOrder response error an array of Error DTOs (#872)

Author: jlevers

resources/metadata/modifications.json

@@ -48,6 +48,18 @@
             "status",
             "statusChangedDate"
           ]
+        },
+        {
+            "comment": "Error Response from Amazon for GetFulfillmentOrder is an array",
+            "action": "replace",
+            "path": "components.schemas.GetFulfillmentOrderResponse.properties.errors",
+            "value": {
+                "type": "array",
+                "description": "A list of error responses returned when a request is unsuccessful.",
+                "items": {
+                    "$ref": "#/components/schemas/Error"
+                }
+            }
         }
       ]
     },
@@ -179,12 +191,12 @@
           }
         },
         {
-          "comment": "Remove unneded objects from ErrorList",
+          "comment": "Remove unneeded objects from ErrorList",
           "action": "delete",
           "path": "components.schemas.ErrorList.properties"
         },
         {
-          "comment": "Remove unneded objects from ErrorList",
+          "comment": "Remove unneeded objects from ErrorList",
           "action": "delete",
           "path": "components.schemas.ErrorList.required"
         }

resources/models/seller/fba-outbound/v2020-07-01.json

@@ -3823,7 +3823,11 @@
                         "$ref": "#/components/schemas/GetFulfillmentOrderResult"
                     },
                     "errors": {
-                        "$ref": "#/components/schemas/ErrorList"
+                        "type": "array",
+                        "description": "A list of error responses returned when a request is unsuccessful.",
+                        "items": {
+                            "$ref": "#/components/schemas/Error"
+                        }
                     }
                 },
                 "description": "The response schema for the `getFulfillmentOrder` operation."

src/Seller/FBAOutboundV20200701/Responses/GetFulfillmentOrderResponse.php

@@ -11,17 +11,19 @@
 namespace SellingPartnerApi\Seller\FBAOutboundV20200701\Responses;
 
 use SellingPartnerApi\Response;
-use SellingPartnerApi\Seller\FBAOutboundV20200701\Dto\ErrorList;
+use SellingPartnerApi\Seller\FBAOutboundV20200701\Dto\Error;
 use SellingPartnerApi\Seller\FBAOutboundV20200701\Dto\GetFulfillmentOrderResult;
 
 final class GetFulfillmentOrderResponse extends Response
 {
+    protected static array $complexArrayTypes = ['errors' => Error::class];
+
     /**
      * @param  ?GetFulfillmentOrderResult  $payload  The request for the getFulfillmentOrder operation.
-     * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
+     * @param  Error[]|null  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(
         public readonly ?GetFulfillmentOrderResult $payload = null,
-        public readonly ?ErrorList $errors = null,
+        public readonly ?array $errors = null,
     ) {}
 }

tests/Seller/OrdersV0/Responses/GetOrdersTest.php

@@ -23,13 +23,13 @@ public function test_deserialize_string_boolean(): void
                         'ShipServiceLevel' => 'Std US D2D Dom',
                         'OrderTotal' => [
                             'CurrencyCode' => 'USD',
-                            'Amount' => '11.01'
+                            'Amount' => '11.01',
                         ],
                         'NumberOfItemsShipped' => 0,
                         'NumberOfItemsUnshipped' => 1,
                         'PaymentMethod' => 'Other',
                         'PaymentMethodDetails' => [
-                            'Standard'
+                            'Standard',
                         ],
                         'IsReplacementOrder' => 'false',
                         'MarketplaceId' => 'ATVPDKIKX0DER',
@@ -53,21 +53,21 @@ public function test_deserialize_string_boolean(): void
                             'PostalCode' => '98121-2778',
                             'CountryCode' => 'US',
                             'Phone' => '+1 480-386-0930 ext. 73824',
-                            'AddressType' => 'Commercial'
+                            'AddressType' => 'Commercial',
                         ],
                         'FulfillmentInstruction' => [
-                            'FulfillmentSupplySourceId' => 'sampleSupplySourceId'
+                            'FulfillmentSupplySourceId' => 'sampleSupplySourceId',
                         ],
                         'IsISPU' => false,
                         'IsAccessPointOrder' => false,
                         'AutomatedShippingSettings' => [
-                            'HasAutomatedShippingSettings' => false
+                            'HasAutomatedShippingSettings' => false,
                         ],
                         'EasyShipShipmentStatus' => 'PendingPickUp',
-                        'ElectronicInvoiceStatus' => 'NotRequired'
-                    ]
-                ]
-            ]
+                        'ElectronicInvoiceStatus' => 'NotRequired',
+                    ],
+                ],
+            ],
         ]);
 
         $this->assertEquals($result->payload->orders[0]->isReplacementOrder, false);