doc(orders): DEVDOCS-6194 add docs for consignment_structure query param

bigcommerce · Jan 17, 2025 · bb45cb1 · bb45cb1
1 parent 90f4cf2
commit bb45cb1
Showing 1 changed file with 13 additions and 4 deletions.
diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml
@@ -79,6 +79,7 @@ paths:
         - Orders
       parameters:
         - $ref: '#/components/parameters/order_includes'
+        - $ref: '#/components/parameters/consignment_structure'
       responses:
         '200':
           $ref: '#/components/responses/order_Resp'
@@ -336,6 +337,7 @@ paths:
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/channel_id'
         - $ref: '#/components/parameters/order_includes'
+        - $ref: '#/components/parameters/consignment_structure'
         - $ref: '#/components/parameters/external_order_id'
       responses:
         '200':
@@ -381,6 +383,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/ContentType'
         - $ref: '#/components/parameters/order_includes'
+        - $ref: '#/components/parameters/consignment_structure'
       requestBody:
         content:
           application/json:
@@ -1419,14 +1422,20 @@ components:
       description: Shipping consignment ID.
       schema:
         type: integer
+    consignment_structure:
+      name: consignment_structure
+      in: query
+      schema:
+        type: string
+        enum:
+          - object
+      description: Should be specified along with `include=consignments` or `include=consignments.line_items` to return consignments in the supported object structure. The default array structure provided is legacy and may not be supported in the future.
     order_includes:
       name: include
       in: query
       description: |-
-        * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments` endpoint.
-        
-        * `consignments.line_items` - include the response returned from the request to the `/orders/{order_id}/products` endpoint in consignments. This implies `include=consignments`.
-
+        * `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 may not be supported in the future.
         * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint.
       style: form
       explode: false