DEVDOCS-4469: [add] PUT - Support Single Shipping Consignment

reference/orders.v2.oas2.yml

@@ -113,7 +113,7 @@ paths:
             schema:
               $ref: '#/components/schemas/order_Put'
             examples:
-              application/json:
+              Updating an Order:
                 value:
                   status_id: 0
                   customer_id: 11
@@ -182,6 +182,24 @@ paths:
                         value: 12
                       price_inc_tax: 12.45
                       price_ex_tax: 10.12
+              Updating an Order's Shipping Consignment:
+                value:
+                  consignments:
+                    - shipping:
+                      id: 149
+                      line_items:
+                        - id: 123
+                          quantity: 1
+                      first_name: "Jane"
+                      last_name: "Doe"
+                      company: "BC"
+                      street_1: "123 Main Street"
+                      city: "Austin"
+                      state: "Texas"
+                      zip: "78751"
+                      country: "United States"
+                      country_iso": "US"
+                      email: "[email protected]"
         required: true
       responses:
         '200':
@@ -300,7 +318,7 @@ paths:
                     zip: '78751'
                     country: United States
                     country_iso2: US
-                    email: janedoe@email.com
+                    email: janedoe@example.com
                   products:
                     - name: BigCommerce Coffee Mug
                       quantity: 1
@@ -1822,7 +1840,7 @@ components:
                   country: United States
                   country_iso2: US
                   phone: '1234567890'
-                  email: janedoe@email.com
+                  email: janedoe@example.com
                   form_fields:
                     name: Delivery Instructions
                     value: Leave in backyard