docs(orders: DEVDOCS-6459 imrpove dev docs for sideloading order consignments

Author: BC-SEven

reference/orders.v2.oas2.yml

@@ -1446,8 +1446,8 @@ components:
       name: include
       in: query
       description: |-
-        * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and may not be supported in the future.
-        * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`. You should also specify `consignment_structure=object` as a request parameter when including consignments. The default array structure provided is legacy and will be removed in the future.
+        * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments.
+        * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify `consignment_structure=object` as a request parameter when including consignments.
         * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint.
       style: form
       explode: false
@@ -1966,7 +1966,7 @@ components:
                 staff_notes: BIN-45
                 customer_message: Custom Journal Added
                 discount_amount: '0'
-                coupon_discount": 0
+                coupon_discount: 0
                 shipping_address_count: 1
                 ebay_order_id: '0'
                 cart_id: 8b84f622-faf1-4c10-887b-f5dff2f9eaf4
@@ -2981,6 +2981,7 @@ components:
       type: object
       description: ''
       x-internal: false
+      additionalProperties: false
       properties:
         id:
           description: Numeric ID of this product within this order.
@@ -4407,7 +4408,9 @@ components:
             Allowed values: `www` (Desktop) | `iphone` (Iphone) | `ipad` (Ipad) | `android` (Android) | `mobile` (Mobile) | `manual` (manual order) | `external` (Orders API) | `checkout_api` (Checkout API) | `buybutton` (Buy Button) | `amazon` (Amazon) | `ebay` (Ebay) | `facebookshop` (Facebook Shop) | `facebookcheckout` (Facebook Checkout) | `facebookmarketplace` (Facebook Marketplace) | `pinterest` (Pinterest) | `socialshop` (Social Shop)
           type: string
         consignments:
-          $ref: '#/components/schemas/orderConsignments_Resource'
+          oneOf:
+            - $ref: '#/components/schemas/orderConsignments_Resource'
+            - $ref: '#/components/schemas/orderConsignment_Get'
         products:
           $ref: '#/components/schemas/products_Resource'
         shipping_addresses:
@@ -5388,9 +5391,13 @@ components:
           example: [email protected]
           description: The recipient email of the gift certificate.
         line_items:
-          type: array
-          items:
-            $ref: '#/components/schemas/products_Resource'
+              oneOf:
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/products_Resource'
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/orderProducts'
     pickupConsignment_Get:
       allOf:
         - type: object
@@ -5409,9 +5416,13 @@ components:
             location:
               $ref: '#/components/schemas/pickupConsignmentLocation_Get'
             line_items:
-              type: array
-              items:
-                $ref: '#/components/schemas/products_Resource'
+              oneOf:
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/products_Resource'
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/orderProducts'
       x-examples:
         example-1:
           id: 99
@@ -5470,9 +5481,13 @@ components:
         - type: object
           properties:
             line_items:
-              type: array
-              items:
-                $ref: '#/components/schemas/products_Resource'
+              oneOf:
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/products_Resource'
+                - type: array
+                  items:
+                    $ref: '#/components/schemas/orderProducts'
             items_total:
               type: number
               example: 1
@@ -5645,9 +5660,13 @@ components:
           example: [email protected]
           description: The recipient email of the digital consignment.
         line_items:
-          type: array
-          items:
-            $ref: '#/components/schemas/products_Resource'
+          oneOf:
+            - type: array
+              items:
+                $ref: '#/components/schemas/products_Resource'
+            - type: array
+              items:
+                $ref: '#/components/schemas/orderProducts'
       x-examples:
         example-1:
           recipient_email: [email protected]