chore(docs): Generated API Reference (automated) (#9962)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_customer-groups/post.sh

@@ -0,0 +1,2 @@
+curl -X POST '{backend_url}/admin/customers/{id}/customer-groups' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml

@@ -25,6 +25,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml

@@ -11,6 +11,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml

@@ -29,30 +29,33 @@ required:
   - updated_at
   - deleted_at
 properties:
-  id:
+  collection:
-    type: string
+    $ref: ./BaseCollection.yaml
-    title: id
+  categories:
-    description: The product's ID.
+    type: array
+    description: The product's categories.
+    items:
+      $ref: ./BaseProductCategory.yaml
+  variants:
+    type: array
+    description: The product's variants.
+    items:
+      type: object
+  type:
+    $ref: ./BaseProductType.yaml
+  tags:
+    type: array
+    description: The product's tags.
+    items:
+      $ref: ./BaseProductTag.yaml
+  length:
+    type: number
+    title: length
+    description: The product's length.
   title:
     type: string
     title: title
     description: The product's title.
-  handle:
-    type: string
-    title: handle
-    description: The product's handle.
-  subtitle:
-    type: string
-    title: subtitle
-    description: The product's subtitle.
-  description:
-    type: string
-    title: description
-    description: The product's description.
-  is_giftcard:
-    type: boolean
-    title: is_giftcard
-    description: Whether the product is a gift card.
   status:
     type: string
     description: The product's status.
@@ -61,10 +64,48 @@ properties:
       - proposed
       - published
       - rejected
+  options:
+    type: array
+    description: The product's options.
+    items:
+      $ref: ./BaseProductOption.yaml
+  description:
+    type: string
+    title: description
+    description: The product's description.
+  id:
+    type: string
+    title: id
+    description: The product's ID.
+  metadata:
+    type: object
+    description: The product's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the product was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the product was updated.
+  handle:
+    type: string
+    title: handle
+    description: The product's unique handle.
+  subtitle:
+    type: string
+    title: subtitle
+    description: The product's subtitle.
+  is_giftcard:
+    type: boolean
+    title: is_giftcard
+    description: Whether the product is a gift card.
   thumbnail:
     type: string
     title: thumbnail
-    description: The product's thumbnail URL.
+    description: The product's thumbnail.
   width:
     type: number
     title: width
@@ -73,10 +114,6 @@ properties:
     type: number
     title: weight
     description: The product's weight.
-  length:
-    type: number
-    title: length
-    description: The product's length.
   height:
     type: number
     title: height
@@ -88,47 +125,23 @@ properties:
   hs_code:
     type: string
     title: hs_code
-    description: The product's hs code.
+    description: The product's HS code.
   mid_code:
     type: string
     title: mid_code
-    description: The product's mid code.
+    description: The product's MID code.
   material:
     type: string
     title: material
     description: The product's material.
-  collection:
-    $ref: ./BaseCollection.yaml
   collection_id:
     type: string
     title: collection_id
-    description: The ID of the collection the product belongs to.
+    description: The ID of the collection that the product belongs to.
-  categories:
-    type: array
-    description: The product's categories.
-    items:
-      $ref: ./BaseProductCategory.yaml
-  type:
-    $ref: ./BaseProductType.yaml
   type_id:
     type: string
     title: type_id
-    description: The ID of the type the product belongs to.
+    description: The ID of the product's type.
-  tags:
-    type: array
-    description: The product's tags.
-    items:
-      $ref: ./BaseProductTag.yaml
-  variants:
-    type: array
-    description: The product's variants.
-    items:
-      type: object
-  options:
-    type: array
-    description: The product's options.
-    items:
-      $ref: ./BaseProductOption.yaml
   images:
     type: array
     description: The product's images.
@@ -137,26 +150,13 @@ properties:
   discountable:
     type: boolean
     title: discountable
-    description: Whether the product is discountable.
+    description: Whether discounts can be applied on the product.
   external_id:
     type: string
     title: external_id
-    description: The ID of the product in an external or third-party system.
+    description: The ID of a product in an external system, such as an ERP or CMS.
-  created_at:
-    type: string
-    format: date-time
-    title: created_at
-    description: The date the product was created.
-  updated_at:
-    type: string
-    format: date-time
-    title: updated_at
-    description: The date the product was updated.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
     description: The date the product was deleted.
-  metadata:
-    type: object
-    description: The product's metadata, can hold custom key-value pairs.

www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml

@@ -20,9 +20,9 @@ properties:
     type: array
     description: The category's children.
     items:
-      type: object
+      $ref: ./AdminProductCategory.yaml
   parent_category:
-    type: object
+    $ref: ./AdminProductCategory.yaml
   products:
     type: array
     description: The category's products.

www/apps/api-reference/specs/admin/components/schemas/Order.yaml

@@ -4,6 +4,7 @@ x-schemaName: Order
 required:
   - id
   - version
+  - display_id
   - status
   - currency_code
   - created_at
@@ -206,3 +207,7 @@ properties:
     type: number
     title: original_shipping_tax_total
     description: The total taxes of the order's shipping excluding promotions.
+  display_id:
+    type: number
+    title: display_id
+    description: The order's display id.

www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml

@@ -23,8 +23,19 @@ properties:
     title: no_notification
     description: Whether to send the customer notifications when the exchange is updated.
   difference_due:
-    type: number
+    oneOf:
-    title: difference_due
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
     description: >-
       The amount to be exchanged or refunded. If the amount is negative, it must
       be refunded. If positive, additional payment is required from the

www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml

@@ -194,3 +194,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total amount that can be refunded of a single quantity of the item.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/admin/components/schemas/Return.yaml

@@ -22,8 +22,19 @@ properties:
       - received
       - partially_received
   refund_amount:
-    type: number
+    oneOf:
-    title: refund_amount
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
     description: The amount refunded by this return.
   order_id:
     type: string

www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml

@@ -26,6 +26,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -4009,3 +4010,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml

@@ -18,3 +18,6 @@ properties:
     type: string
     title: phone
     description: The customer's phone.
+  metadata:
+    type: object
+    description: The customer's metadata.

www/apps/api-reference/specs/admin/openapi.full.yaml

@@ -11424,6 +11424,85 @@ paths:
         '500':
           $ref: '#/components/responses/500_error'
       x-workflow: deleteCustomerAddressesWorkflow
+  /admin/customers/{id}/customer-groups:
+    post:
+      operationId: PostCustomersIdCustomerGroups
+      summary: Add Customer Group to Customer
+      description: Add a Customer Group to a customer
+      x-authenticated: true
+      parameters:
+        - name: id
+          in: path
+          description: The customer's ID.
+          required: true
+          schema:
+            type: string
+        - name: fields
+          in: query
+          description: |-
+            Comma-separated fields that should be included in the returned data.
+             * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+             * without prefix it will replace the entire default fields.
+          required: false
+          schema:
+            type: string
+            title: fields
+            description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. Without prefix it will replace the entire default fields.
+            externalDocs:
+              url: '#select-fields-and-relations'
+      security:
+        - api_token: []
+        - cookie_auth: []
+        - jwt_token: []
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              description: SUMMARY
+              properties:
+                add:
+                  type: array
+                  description: The customer's add.
+                  items:
+                    type: string
+                    title: add
+                    description: The add's details.
+                remove:
+                  type: array
+                  description: The customer's remove.
+                  items:
+                    type: string
+                    title: remove
+                    description: The remove's details.
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |-
+            curl -X POST '{backend_url}/admin/customers/{id}/customer-groups' \
+            -H 'Authorization: Bearer {access_token}'
+      tags:
+        - Customers
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminCustomerResponse'
+        '400':
+          $ref: '#/components/responses/400_error'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/not_found_error'
+        '409':
+          $ref: '#/components/responses/invalid_state_error'
+        '422':
+          $ref: '#/components/responses/invalid_request_error'
+        '500':
+          $ref: '#/components/responses/500_error'
+      x-workflow: linkCustomerGroupsToCustomerWorkflow
   /admin/draft-orders:
     get:
       operationId: GetDraftOrders
@@ -12393,12 +12472,16 @@ paths:
           description: Filter by region IDs to retrieve their associated draft orders.
           required: false
           schema:
-            type: array
+            oneOf:
-            description: Filter by region IDs to retrieve their associated draft orders.
+              - type: string
-            items:
+                title: region_id
-              type: string
+                description: The draft order's region id.
-              title: region_id
+              - type: array
-              description: A region's ID.
+                description: The draft order's region id.
+                items:
+                  type: string
+                  title: region_id
+                  description: The region id's details.
         - name: q
           in: query
           description: Search term to filter the order's searchable properties.
@@ -12869,6 +12952,20 @@ paths:
                 type: boolean
                 title: $exists
                 description: Filter by whether a value for this parameter exists (not `null`).
+        - name: customer_id
+          in: query
+          required: false
+          schema:
+            oneOf:
+              - type: string
+                title: customer_id
+                description: The draft order's customer id.
+              - type: array
+                description: The draft order's customer id.
+                items:
+                  type: string
+                  title: customer_id
+                  description: The customer id's details.
       security:
         - api_token: []
         - cookie_auth: []
@@ -16853,20 +16950,6 @@ paths:
             type: string
             title: order
             description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
-        - name: location_id
-          in: query
-          required: false
-          schema:
-            oneOf:
-              - type: string
-                title: location_id
-                description: Filter by an associated location's ID.
-              - type: array
-                description: Filter by associated location IDs.
-                items:
-                  type: string
-                  title: location_id
-                  description: An associated location ID.
         - name: $and
           in: query
           required: false
@@ -19031,12 +19114,16 @@ paths:
           description: Filter by region IDs to retrieve their associated orders.
           required: false
           schema:
-            type: array
+            oneOf:
-            description: Filter by region IDs to retrieve their associated orders.
+              - type: string
-            items:
+                title: region_id
-              type: string
+                description: The order's region id.
-              title: region_id
+              - type: array
-              description: A region ID.
+                description: The order's region id.
+                items:
+                  type: string
+                  title: region_id
+                  description: The region id's details.
         - name: q
           in: query
           description: Search term to filter the order's searchable properties.
@@ -19507,6 +19594,20 @@ paths:
                 type: boolean
                 title: $exists
                 description: Filter by whether a value for this parameter exists (not `null`).
+        - name: customer_id
+          in: query
+          required: false
+          schema:
+            oneOf:
+              - type: string
+                title: customer_id
+                description: The order's customer id.
+              - type: array
+                description: The order's customer id.
+                items:
+                  type: string
+                  title: customer_id
+                  description: The customer id's details.
       security:
         - api_token: []
         - cookie_auth: []
@@ -33451,12 +33552,16 @@ paths:
           description: Filter by region IDs to retrieve their associated returns.
           required: false
           schema:
-            type: array
+            oneOf:
-            description: Filter by region IDs to retrieve their associated returns.
+              - type: string
-            items:
+                title: region_id
-              type: string
+                description: The return's region id.
-              title: region_id
+              - type: array
-              description: The region id's details.
+                description: The return's region id.
+                items:
+                  type: string
+                  title: region_id
+                  description: The region id's details.
         - name: q
           in: query
           description: Search term to filter the return's searchable properties.
@@ -33927,6 +34032,20 @@ paths:
                 type: boolean
                 title: $exists
                 description: Filter by whether a value for this parameter exists (not `null`).
+        - name: customer_id
+          in: query
+          required: false
+          schema:
+            oneOf:
+              - type: string
+                title: customer_id
+                description: The return's customer id.
+              - type: array
+                description: The return's customer id.
+                items:
+                  type: string
+                  title: customer_id
+                  description: The customer id's details.
       security:
         - api_token: []
         - cookie_auth: []
@@ -48043,6 +48162,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -48229,6 +48349,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     AdminOrderPreview:
       type: object
       description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -55622,6 +55746,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -55822,6 +55947,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     BaseOrderLineItemAdjustment:
       type: object
       description: The adjustment's details.
@@ -56608,30 +56737,33 @@ components:
         - updated_at
         - deleted_at
       properties:
-        id:
+        collection:
-          type: string
+          $ref: '#/components/schemas/BaseCollection'
-          title: id
+        categories:
-          description: The product's ID.
+          type: array
+          description: The product's categories.
+          items:
+            $ref: '#/components/schemas/BaseProductCategory'
+        variants:
+          type: array
+          description: The product's variants.
+          items:
+            type: object
+        type:
+          $ref: '#/components/schemas/BaseProductType'
+        tags:
+          type: array
+          description: The product's tags.
+          items:
+            $ref: '#/components/schemas/BaseProductTag'
+        length:
+          type: number
+          title: length
+          description: The product's length.
         title:
           type: string
           title: title
           description: The product's title.
-        handle:
-          type: string
-          title: handle
-          description: The product's handle.
-        subtitle:
-          type: string
-          title: subtitle
-          description: The product's subtitle.
-        description:
-          type: string
-          title: description
-          description: The product's description.
-        is_giftcard:
-          type: boolean
-          title: is_giftcard
-          description: Whether the product is a gift card.
         status:
           type: string
           description: The product's status.
@@ -56640,10 +56772,48 @@ components:
             - proposed
             - published
             - rejected
+        options:
+          type: array
+          description: The product's options.
+          items:
+            $ref: '#/components/schemas/BaseProductOption'
+        description:
+          type: string
+          title: description
+          description: The product's description.
+        id:
+          type: string
+          title: id
+          description: The product's ID.
+        metadata:
+          type: object
+          description: The product's metadata, can hold custom key-value pairs.
+        created_at:
+          type: string
+          format: date-time
+          title: created_at
+          description: The date the product was created.
+        updated_at:
+          type: string
+          format: date-time
+          title: updated_at
+          description: The date the product was updated.
+        handle:
+          type: string
+          title: handle
+          description: The product's unique handle.
+        subtitle:
+          type: string
+          title: subtitle
+          description: The product's subtitle.
+        is_giftcard:
+          type: boolean
+          title: is_giftcard
+          description: Whether the product is a gift card.
         thumbnail:
           type: string
           title: thumbnail
-          description: The product's thumbnail URL.
+          description: The product's thumbnail.
         width:
           type: number
           title: width
@@ -56652,10 +56822,6 @@ components:
           type: number
           title: weight
           description: The product's weight.
-        length:
-          type: number
-          title: length
-          description: The product's length.
         height:
           type: number
           title: height
@@ -56667,47 +56833,23 @@ components:
         hs_code:
           type: string
           title: hs_code
-          description: The product's hs code.
+          description: The product's HS code.
         mid_code:
           type: string
           title: mid_code
-          description: The product's mid code.
+          description: The product's MID code.
         material:
           type: string
           title: material
           description: The product's material.
-        collection:
-          $ref: '#/components/schemas/BaseCollection'
         collection_id:
           type: string
           title: collection_id
-          description: The ID of the collection the product belongs to.
+          description: The ID of the collection that the product belongs to.
-        categories:
-          type: array
-          description: The product's categories.
-          items:
-            $ref: '#/components/schemas/BaseProductCategory'
-        type:
-          $ref: '#/components/schemas/BaseProductType'
         type_id:
           type: string
           title: type_id
-          description: The ID of the type the product belongs to.
+          description: The ID of the product's type.
-        tags:
-          type: array
-          description: The product's tags.
-          items:
-            $ref: '#/components/schemas/BaseProductTag'
-        variants:
-          type: array
-          description: The product's variants.
-          items:
-            type: object
-        options:
-          type: array
-          description: The product's options.
-          items:
-            $ref: '#/components/schemas/BaseProductOption'
         images:
           type: array
           description: The product's images.
@@ -56716,29 +56858,16 @@ components:
         discountable:
           type: boolean
           title: discountable
-          description: Whether the product is discountable.
+          description: Whether discounts can be applied on the product.
         external_id:
           type: string
           title: external_id
-          description: The ID of the product in an external or third-party system.
+          description: The ID of a product in an external system, such as an ERP or CMS.
-        created_at:
-          type: string
-          format: date-time
-          title: created_at
-          description: The date the product was created.
-        updated_at:
-          type: string
-          format: date-time
-          title: updated_at
-          description: The date the product was updated.
         deleted_at:
           type: string
           format: date-time
           title: deleted_at
           description: The date the product was deleted.
-        metadata:
-          type: object
-          description: The product's metadata, can hold custom key-value pairs.
     BaseProductCategory:
       type: object
       description: The product category's details.
@@ -56762,9 +56891,9 @@ components:
           type: array
           description: The category's children.
           items:
-            type: object
+            $ref: '#/components/schemas/AdminProductCategory'
         parent_category:
-          type: object
+          $ref: '#/components/schemas/AdminProductCategory'
         products:
           type: array
           description: The category's products.
@@ -58009,6 +58138,7 @@ components:
       required:
         - id
         - version
+        - display_id
         - status
         - currency_code
         - created_at
@@ -58211,6 +58341,10 @@ components:
           type: number
           title: original_shipping_tax_total
           description: The total taxes of the order's shipping excluding promotions.
+        display_id:
+          type: number
+          title: display_id
+          description: The order's display id.
     OrderAddress:
       type: object
       description: The address's details.
@@ -58673,8 +58807,19 @@ components:
           title: no_notification
           description: Whether to send the customer notifications when the exchange is updated.
         difference_due:
-          type: number
+          oneOf:
-          title: difference_due
+            - type: string
+              title: difference_due
+              description: The exchange's difference due.
+            - type: number
+              title: difference_due
+              description: The exchange's difference due.
+            - type: string
+              title: difference_due
+              description: The exchange's difference due.
+            - type: number
+              title: difference_due
+              description: The exchange's difference due.
           description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
         return:
           $ref: '#/components/schemas/Return'
@@ -59023,6 +59168,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total amount that can be refunded of a single quantity of the item.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     OrderLineItemAdjustment:
       type: object
       description: The line item adjustment's details.
@@ -59553,8 +59702,19 @@ components:
             - received
             - partially_received
         refund_amount:
-          type: number
+          oneOf:
-          title: refund_amount
+            - type: string
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: number
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: string
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: number
+              title: refund_amount
+              description: The return order's refund amount.
           description: The amount refunded by this return.
         order_id:
           type: string
@@ -61544,6 +61704,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -65527,6 +65688,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     StoreOrderResponse:
       type: object
       description: The order's details.
@@ -68394,6 +68559,9 @@ components:
           type: string
           title: phone
           description: The customer's phone.
+        metadata:
+          type: object
+          description: The customer's metadata.
     UpdateAddress:
       type: object
       description: The details to update in the address.

www/apps/api-reference/specs/admin/openapi.yaml

@@ -693,6 +693,8 @@ paths:
     $ref: paths/admin_customers_{id}_addresses.yaml
   /admin/customers/{id}/addresses/{address_id}:
     $ref: paths/admin_customers_{id}_addresses_{address_id}.yaml
+  /admin/customers/{id}/customer-groups:
+    $ref: paths/admin_customers_{id}_customer-groups.yaml
   /admin/draft-orders:
     $ref: paths/admin_draft-orders.yaml
   /admin/draft-orders/{id}:

www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml

@@ -0,0 +1,81 @@
+post:
+  operationId: PostCustomersIdCustomerGroups
+  summary: Add Customer Group to Customer
+  description: Add a Customer Group to a customer
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The customer's ID.
+      required: true
+      schema:
+        type: string
+    - name: fields
+      in: query
+      description: |-
+        Comma-separated fields that should be included in the returned data.
+         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+         * without prefix it will replace the entire default fields.
+      required: false
+      schema:
+        type: string
+        title: fields
+        description: >-
+          Comma-separated fields that should be included in the returned data.
+          If a field is prefixed with `+` it will be added to the default
+          fields, using `-` will remove it from the default fields. Without
+          prefix it will replace the entire default fields.
+        externalDocs:
+          url: '#select-fields-and-relations'
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: object
+          description: SUMMARY
+          properties:
+            add:
+              type: array
+              description: The customer's add.
+              items:
+                type: string
+                title: add
+                description: The add's details.
+            remove:
+              type: array
+              description: The customer's remove.
+              items:
+                type: string
+                title: remove
+                description: The remove's details.
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_customers_{id}_customer-groups/post.sh
+  tags:
+    - Customers
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminCustomerResponse.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-workflow: linkCustomerGroupsToCustomerWorkflow

www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml

@@ -1217,12 +1217,16 @@ get:
       description: Filter by region IDs to retrieve their associated draft orders.
       required: false
       schema:
-        type: array
+        oneOf:
-        description: Filter by region IDs to retrieve their associated draft orders.
+          - type: string
-        items:
+            title: region_id
-          type: string
+            description: The draft order's region id.
-          title: region_id
+          - type: array
-          description: A region's ID.
+            description: The draft order's region id.
+            items:
+              type: string
+              title: region_id
+              description: The region id's details.
     - name: q
       in: query
       description: Search term to filter the order's searchable properties.
@@ -1769,6 +1773,20 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+    - name: customer_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: customer_id
+            description: The draft order's customer id.
+          - type: array
+            description: The draft order's customer id.
+            items:
+              type: string
+              title: customer_id
+              description: The customer id's details.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml

@@ -64,20 +64,6 @@ get:
           The field to sort the data by. By default, the sort order is
           ascending. To change the order to descending, prefix the field name
           with `-`.
-    - name: location_id
-      in: query
-      required: false
-      schema:
-        oneOf:
-          - type: string
-            title: location_id
-            description: Filter by an associated location's ID.
-          - type: array
-            description: Filter by associated location IDs.
-            items:
-              type: string
-              title: location_id
-              description: An associated location ID.
     - name: $and
       in: query
       required: false

www/apps/api-reference/specs/admin/paths/admin_orders.yaml

@@ -171,12 +171,16 @@ get:
       description: Filter by region IDs to retrieve their associated orders.
       required: false
       schema:
-        type: array
+        oneOf:
-        description: Filter by region IDs to retrieve their associated orders.
+          - type: string
-        items:
+            title: region_id
-          type: string
+            description: The order's region id.
-          title: region_id
+          - type: array
-          description: A region ID.
+            description: The order's region id.
+            items:
+              type: string
+              title: region_id
+              description: The region id's details.
     - name: q
       in: query
       description: Search term to filter the order's searchable properties.
@@ -723,6 +727,20 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+    - name: customer_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: customer_id
+            description: The order's customer id.
+          - type: array
+            description: The order's customer id.
+            items:
+              type: string
+              title: customer_id
+              description: The customer id's details.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_returns.yaml

@@ -169,12 +169,16 @@ get:
       description: Filter by region IDs to retrieve their associated returns.
       required: false
       schema:
-        type: array
+        oneOf:
-        description: Filter by region IDs to retrieve their associated returns.
+          - type: string
-        items:
+            title: region_id
-          type: string
+            description: The return's region id.
-          title: region_id
+          - type: array
-          description: The region id's details.
+            description: The return's region id.
+            items:
+              type: string
+              title: region_id
+              description: The region id's details.
     - name: q
       in: query
       description: Search term to filter the return's searchable properties.
@@ -721,6 +725,20 @@ get:
             type: boolean
             title: $exists
             description: Filter by whether a value for this parameter exists (not `null`).
+    - name: customer_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: customer_id
+            description: The return's customer id.
+          - type: array
+            description: The return's customer id.
+            items:
+              type: string
+              title: customer_id
+              description: The customer id's details.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml

@@ -25,6 +25,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml

@@ -41,7 +41,7 @@ properties:
     type: array
     description: The collection's products.
     items:
-      type: object
+      $ref: ./BaseProduct.yaml
   metadata:
     type: object
     description: The collection's metadata, used to store custom key-value pairs.

www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml

@@ -11,6 +11,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -211,3 +212,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml

@@ -29,30 +29,33 @@ required:
   - updated_at
   - deleted_at
 properties:
-  id:
+  collection:
-    type: string
+    $ref: ./BaseCollection.yaml
-    title: id
+  categories:
-    description: The product's ID.
+    type: array
+    description: The product's categories.
+    items:
+      $ref: ./BaseProductCategory.yaml
+  variants:
+    type: array
+    description: The product's variants.
+    items:
+      type: object
+  type:
+    $ref: ./BaseProductType.yaml
+  tags:
+    type: array
+    description: The product's tags.
+    items:
+      $ref: ./BaseProductTag.yaml
+  length:
+    type: number
+    title: length
+    description: The product's length.
   title:
     type: string
     title: title
     description: The product's title.
-  handle:
-    type: string
-    title: handle
-    description: The product's handle.
-  subtitle:
-    type: string
-    title: subtitle
-    description: The product's subtitle.
-  description:
-    type: string
-    title: description
-    description: The product's description.
-  is_giftcard:
-    type: boolean
-    title: is_giftcard
-    description: Whether the product is a gift card.
   status:
     type: string
     description: The product's status.
@@ -61,10 +64,48 @@ properties:
       - proposed
       - published
       - rejected
+  options:
+    type: array
+    description: The product's options.
+    items:
+      $ref: ./BaseProductOption.yaml
+  description:
+    type: string
+    title: description
+    description: The product's description.
+  id:
+    type: string
+    title: id
+    description: The product's ID.
+  metadata:
+    type: object
+    description: The product's metadata, can hold custom key-value pairs.
+  created_at:
+    type: string
+    format: date-time
+    title: created_at
+    description: The date the product was created.
+  updated_at:
+    type: string
+    format: date-time
+    title: updated_at
+    description: The date the product was updated.
+  handle:
+    type: string
+    title: handle
+    description: The product's unique handle.
+  subtitle:
+    type: string
+    title: subtitle
+    description: The product's subtitle.
+  is_giftcard:
+    type: boolean
+    title: is_giftcard
+    description: Whether the product is a gift card.
   thumbnail:
     type: string
     title: thumbnail
-    description: The product's thumbnail URL.
+    description: The product's thumbnail.
   width:
     type: number
     title: width
@@ -73,10 +114,6 @@ properties:
     type: number
     title: weight
     description: The product's weight.
-  length:
-    type: number
-    title: length
-    description: The product's length.
   height:
     type: number
     title: height
@@ -88,47 +125,23 @@ properties:
   hs_code:
     type: string
     title: hs_code
-    description: The product's hs code.
+    description: The product's HS code.
   mid_code:
     type: string
     title: mid_code
-    description: The product's mid code.
+    description: The product's MID code.
   material:
     type: string
     title: material
     description: The product's material.
-  collection:
-    $ref: ./BaseCollection.yaml
   collection_id:
     type: string
     title: collection_id
-    description: The ID of the collection the product belongs to.
+    description: The ID of the collection that the product belongs to.
-  categories:
-    type: array
-    description: The product's categories.
-    items:
-      $ref: ./BaseProductCategory.yaml
-  type:
-    $ref: ./BaseProductType.yaml
   type_id:
     type: string
     title: type_id
-    description: The ID of the type the product belongs to.
+    description: The ID of the product's type.
-  tags:
-    type: array
-    description: The product's tags.
-    items:
-      $ref: ./BaseProductTag.yaml
-  variants:
-    type: array
-    description: The product's variants.
-    items:
-      type: object
-  options:
-    type: array
-    description: The product's options.
-    items:
-      $ref: ./BaseProductOption.yaml
   images:
     type: array
     description: The product's images.
@@ -137,26 +150,13 @@ properties:
   discountable:
     type: boolean
     title: discountable
-    description: Whether the product is discountable.
+    description: Whether discounts can be applied on the product.
   external_id:
     type: string
     title: external_id
-    description: The ID of the product in an external or third-party system.
+    description: The ID of a product in an external system, such as an ERP or CMS.
-  created_at:
-    type: string
-    format: date-time
-    title: created_at
-    description: The date the product was created.
-  updated_at:
-    type: string
-    format: date-time
-    title: updated_at
-    description: The date the product was updated.
   deleted_at:
     type: string
     format: date-time
     title: deleted_at
     description: The date the product was deleted.
-  metadata:
-    type: object
-    description: The product's metadata, can hold custom key-value pairs.

www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml

@@ -20,14 +20,14 @@ properties:
     type: array
     description: The category's children.
     items:
-      type: object
+      $ref: ./AdminProductCategory.yaml
   parent_category:
-    type: object
+    $ref: ./AdminProductCategory.yaml
   products:
     type: array
     description: The category's products.
     items:
-      type: object
+      $ref: ./AdminProduct.yaml
   name:
     type: string
     title: name

www/apps/api-reference/specs/store/components/schemas/Order.yaml

@@ -4,6 +4,7 @@ x-schemaName: Order
 required:
   - id
   - version
+  - display_id
   - status
   - currency_code
   - created_at
@@ -206,3 +207,7 @@ properties:
     type: number
     title: original_shipping_tax_total
     description: The total taxes of the order's shipping excluding promotions.
+  display_id:
+    type: number
+    title: display_id
+    description: The order's display id.

www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml

@@ -23,8 +23,19 @@ properties:
     title: no_notification
     description: Whether to send the customer notifications when the exchange is updated.
   difference_due:
-    type: number
+    oneOf:
-    title: difference_due
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
+      - type: string
+        title: difference_due
+        description: The exchange's difference due.
+      - type: number
+        title: difference_due
+        description: The exchange's difference due.
     description: >-
       The amount to be exchanged or refunded. If the amount is negative, it must
       be refunded. If positive, additional payment is required from the

www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml

@@ -194,3 +194,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total amount that can be refunded of a single quantity of the item.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/store/components/schemas/Return.yaml

@@ -22,8 +22,19 @@ properties:
       - received
       - partially_received
   refund_amount:
-    type: number
+    oneOf:
-    title: refund_amount
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: string
+        title: refund_amount
+        description: The return order's refund amount.
+      - type: number
+        title: refund_amount
+        description: The return order's refund amount.
     description: The amount refunded by this return.
   order_id:
     type: string
@@ -83,7 +94,7 @@ properties:
     title: exchange_id
     description: The ID of the exchange this return belongs to, if any.
   exchange:
-    type: object
+    $ref: ./OrderExchange.yaml
   claim_id:
     type: string
     title: claim_id

www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml

@@ -26,6 +26,7 @@ required:
   - product_title
   - product_description
   - product_subtitle
+  - product_type_id
   - product_type
   - product_collection
   - product_handle
@@ -4009,3 +4010,7 @@ properties:
     type: number
     title: refundable_total_per_unit
     description: The total refundable amount of the item's total for a single quantity.
+  product_type_id:
+    type: string
+    title: product_type_id
+    description: The item's product type id.

www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml

@@ -18,3 +18,6 @@ properties:
     type: string
     title: phone
     description: The customer's phone.
+  metadata:
+    type: object
+    description: The customer's metadata.

www/apps/api-reference/specs/store/openapi.full.yaml

@@ -10192,6 +10192,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -10378,6 +10379,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     AdminOrderPreview:
       type: object
       description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -17771,6 +17776,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -17971,6 +17977,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     BaseOrderLineItemAdjustment:
       type: object
       description: The adjustment's details.
@@ -18757,30 +18767,33 @@ components:
         - updated_at
         - deleted_at
       properties:
-        id:
+        collection:
-          type: string
+          $ref: '#/components/schemas/BaseCollection'
-          title: id
+        categories:
-          description: The product's ID.
+          type: array
+          description: The product's categories.
+          items:
+            $ref: '#/components/schemas/BaseProductCategory'
+        variants:
+          type: array
+          description: The product's variants.
+          items:
+            type: object
+        type:
+          $ref: '#/components/schemas/BaseProductType'
+        tags:
+          type: array
+          description: The product's tags.
+          items:
+            $ref: '#/components/schemas/BaseProductTag'
+        length:
+          type: number
+          title: length
+          description: The product's length.
         title:
           type: string
           title: title
           description: The product's title.
-        handle:
-          type: string
-          title: handle
-          description: The product's handle.
-        subtitle:
-          type: string
-          title: subtitle
-          description: The product's subtitle.
-        description:
-          type: string
-          title: description
-          description: The product's description.
-        is_giftcard:
-          type: boolean
-          title: is_giftcard
-          description: Whether the product is a gift card.
         status:
           type: string
           description: The product's status.
@@ -18789,10 +18802,48 @@ components:
             - proposed
             - published
             - rejected
+        options:
+          type: array
+          description: The product's options.
+          items:
+            $ref: '#/components/schemas/BaseProductOption'
+        description:
+          type: string
+          title: description
+          description: The product's description.
+        id:
+          type: string
+          title: id
+          description: The product's ID.
+        metadata:
+          type: object
+          description: The product's metadata, can hold custom key-value pairs.
+        created_at:
+          type: string
+          format: date-time
+          title: created_at
+          description: The date the product was created.
+        updated_at:
+          type: string
+          format: date-time
+          title: updated_at
+          description: The date the product was updated.
+        handle:
+          type: string
+          title: handle
+          description: The product's unique handle.
+        subtitle:
+          type: string
+          title: subtitle
+          description: The product's subtitle.
+        is_giftcard:
+          type: boolean
+          title: is_giftcard
+          description: Whether the product is a gift card.
         thumbnail:
           type: string
           title: thumbnail
-          description: The product's thumbnail URL.
+          description: The product's thumbnail.
         width:
           type: number
           title: width
@@ -18801,10 +18852,6 @@ components:
           type: number
           title: weight
           description: The product's weight.
-        length:
-          type: number
-          title: length
-          description: The product's length.
         height:
           type: number
           title: height
@@ -18816,47 +18863,23 @@ components:
         hs_code:
           type: string
           title: hs_code
-          description: The product's hs code.
+          description: The product's HS code.
         mid_code:
           type: string
           title: mid_code
-          description: The product's mid code.
+          description: The product's MID code.
         material:
           type: string
           title: material
           description: The product's material.
-        collection:
-          $ref: '#/components/schemas/BaseCollection'
         collection_id:
           type: string
           title: collection_id
-          description: The ID of the collection the product belongs to.
+          description: The ID of the collection that the product belongs to.
-        categories:
-          type: array
-          description: The product's categories.
-          items:
-            $ref: '#/components/schemas/BaseProductCategory'
-        type:
-          $ref: '#/components/schemas/BaseProductType'
         type_id:
           type: string
           title: type_id
-          description: The ID of the type the product belongs to.
+          description: The ID of the product's type.
-        tags:
-          type: array
-          description: The product's tags.
-          items:
-            $ref: '#/components/schemas/BaseProductTag'
-        variants:
-          type: array
-          description: The product's variants.
-          items:
-            type: object
-        options:
-          type: array
-          description: The product's options.
-          items:
-            $ref: '#/components/schemas/BaseProductOption'
         images:
           type: array
           description: The product's images.
@@ -18865,29 +18888,16 @@ components:
         discountable:
           type: boolean
           title: discountable
-          description: Whether the product is discountable.
+          description: Whether discounts can be applied on the product.
         external_id:
           type: string
           title: external_id
-          description: The ID of the product in an external or third-party system.
+          description: The ID of a product in an external system, such as an ERP or CMS.
-        created_at:
-          type: string
-          format: date-time
-          title: created_at
-          description: The date the product was created.
-        updated_at:
-          type: string
-          format: date-time
-          title: updated_at
-          description: The date the product was updated.
         deleted_at:
           type: string
           format: date-time
           title: deleted_at
           description: The date the product was deleted.
-        metadata:
-          type: object
-          description: The product's metadata, can hold custom key-value pairs.
     BaseProductCategory:
       type: object
       description: The product category's details.
@@ -18911,9 +18921,9 @@ components:
           type: array
           description: The category's children.
           items:
-            type: object
+            $ref: '#/components/schemas/AdminProductCategory'
         parent_category:
-          type: object
+          $ref: '#/components/schemas/AdminProductCategory'
         products:
           type: array
           description: The category's products.
@@ -20158,6 +20168,7 @@ components:
       required:
         - id
         - version
+        - display_id
         - status
         - currency_code
         - created_at
@@ -20360,6 +20371,10 @@ components:
           type: number
           title: original_shipping_tax_total
           description: The total taxes of the order's shipping excluding promotions.
+        display_id:
+          type: number
+          title: display_id
+          description: The order's display id.
     OrderAddress:
       type: object
       description: The address's details.
@@ -20822,8 +20837,19 @@ components:
           title: no_notification
           description: Whether to send the customer notifications when the exchange is updated.
         difference_due:
-          type: number
+          oneOf:
-          title: difference_due
+            - type: string
+              title: difference_due
+              description: The exchange's difference due.
+            - type: number
+              title: difference_due
+              description: The exchange's difference due.
+            - type: string
+              title: difference_due
+              description: The exchange's difference due.
+            - type: number
+              title: difference_due
+              description: The exchange's difference due.
           description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
         return:
           $ref: '#/components/schemas/Return'
@@ -21172,6 +21198,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total amount that can be refunded of a single quantity of the item.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     OrderLineItemAdjustment:
       type: object
       description: The line item adjustment's details.
@@ -21702,8 +21732,19 @@ components:
             - received
             - partially_received
         refund_amount:
-          type: number
+          oneOf:
-          title: refund_amount
+            - type: string
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: number
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: string
+              title: refund_amount
+              description: The return order's refund amount.
+            - type: number
+              title: refund_amount
+              description: The return order's refund amount.
           description: The amount refunded by this return.
         order_id:
           type: string
@@ -23693,6 +23734,7 @@ components:
         - product_title
         - product_description
         - product_subtitle
+        - product_type_id
         - product_type
         - product_collection
         - product_handle
@@ -27676,6 +27718,10 @@ components:
           type: number
           title: refundable_total_per_unit
           description: The total refundable amount of the item's total for a single quantity.
+        product_type_id:
+          type: string
+          title: product_type_id
+          description: The item's product type id.
     StoreOrderResponse:
       type: object
       description: The order's details.
@@ -30543,6 +30589,9 @@ components:
           type: string
           title: phone
           description: The customer's phone.
+        metadata:
+          type: object
+          description: The customer's metadata.
     UpdateAddress:
       type: object
       description: The details to update in the address.

www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts

@@ -969,12 +969,16 @@
  *     description: Filter by region IDs to retrieve their associated draft orders.
  *     required: false
  *     schema:
- *       type: array
+ *       oneOf:
- *       description: Filter by region IDs to retrieve their associated draft orders.
+ *         - type: string
- *       items:
+ *           title: region_id
- *         type: string
+ *           description: The draft order's region id.
- *         title: region_id
+ *         - type: array
- *         description: A region's ID.
+ *           description: The draft order's region id.
+ *           items:
+ *             type: string
+ *             title: region_id
+ *             description: The region id's details.
  *   - name: q
  *     in: query
  *     description: Search term to filter the order's searchable properties.
@@ -1445,6 +1449,20 @@
  *           type: boolean
  *           title: $exists
  *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: customer_id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: customer_id
+ *           description: The draft order's customer id.
+ *         - type: array
+ *           description: The draft order's customer id.
+ *           items:
+ *             type: string
+ *             title: customer_id
+ *             description: The customer id's details.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts

@@ -51,20 +51,6 @@
  *       type: string
  *       title: order
  *       description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
- *   - name: location_id
- *     in: query
- *     required: false
- *     schema:
- *       oneOf:
- *         - type: string
- *           title: location_id
- *           description: Filter by an associated location's ID.
- *         - type: array
- *           description: Filter by associated location IDs.
- *           items:
- *             type: string
- *             title: location_id
- *             description: An associated location ID.
  *   - name: $and
  *     in: query
  *     required: false

www/utils/generated/oas-output/operations/admin/get_admin_orders.ts

@@ -149,12 +149,16 @@
  *     description: Filter by region IDs to retrieve their associated orders.
  *     required: false
  *     schema:
- *       type: array
+ *       oneOf:
- *       description: Filter by region IDs to retrieve their associated orders.
+ *         - type: string
- *       items:
+ *           title: region_id
- *         type: string
+ *           description: The order's region id.
- *         title: region_id
+ *         - type: array
- *         description: A region ID.
+ *           description: The order's region id.
+ *           items:
+ *             type: string
+ *             title: region_id
+ *             description: The region id's details.
  *   - name: q
  *     in: query
  *     description: Search term to filter the order's searchable properties.
@@ -625,6 +629,20 @@
  *           type: boolean
  *           title: $exists
  *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: customer_id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: customer_id
+ *           description: The order's customer id.
+ *         - type: array
+ *           description: The order's customer id.
+ *           items:
+ *             type: string
+ *             title: customer_id
+ *             description: The customer id's details.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

www/utils/generated/oas-output/operations/admin/get_admin_returns.ts

@@ -149,12 +149,16 @@
  *     description: Filter by region IDs to retrieve their associated returns.
  *     required: false
  *     schema:
- *       type: array
+ *       oneOf:
- *       description: Filter by region IDs to retrieve their associated returns.
+ *         - type: string
- *       items:
+ *           title: region_id
- *         type: string
+ *           description: The return's region id.
- *         title: region_id
+ *         - type: array
- *         description: The region id's details.
+ *           description: The return's region id.
+ *           items:
+ *             type: string
+ *             title: region_id
+ *             description: The region id's details.
  *   - name: q
  *     in: query
  *     description: Search term to filter the return's searchable properties.
@@ -625,6 +629,20 @@
  *           type: boolean
  *           title: $exists
  *           description: Filter by whether a value for this parameter exists (not `null`).
+ *   - name: customer_id
+ *     in: query
+ *     required: false
+ *     schema:
+ *       oneOf:
+ *         - type: string
+ *           title: customer_id
+ *           description: The return's customer id.
+ *         - type: array
+ *           description: The return's customer id.
+ *           items:
+ *             type: string
+ *             title: customer_id
+ *             description: The customer id's details.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts

@@ -0,0 +1,83 @@
+/**
+ * @oas [post] /admin/customers/{id}/customer-groups
+ * operationId: PostCustomersIdCustomerGroups
+ * summary: Add Customer Group to Customer
+ * description: Add a Customer Group to a customer
+ * x-authenticated: true
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The customer's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: fields
+ *     in: query
+ *     description: |-
+ *       Comma-separated fields that should be included in the returned data.
+ *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *        * without prefix it will replace the entire default fields.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
+ *         fields. Without prefix it will replace the entire default fields.
+ *       externalDocs:
+ *         url: "#select-fields-and-relations"
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         type: object
+ *         description: SUMMARY
+ *         properties:
+ *           add:
+ *             type: array
+ *             description: The customer's add.
+ *             items:
+ *               type: string
+ *               title: add
+ *               description: The add's details.
+ *           remove:
+ *             type: array
+ *             description: The customer's remove.
+ *             items:
+ *               type: string
+ *               title: remove
+ *               description: The remove's details.
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/customers/{id}/customer-groups' \
+ *       -H 'Authorization: Bearer {access_token}'
+ * tags:
+ *   - Customers
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminCustomerResponse"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * x-workflow: linkCustomerGroupsToCustomerWorkflow
+ * 
+*/
+

www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts

@@ -27,6 +27,7 @@
  *   - product_title
  *   - product_description
  *   - product_subtitle
+ *   - product_type_id
  *   - product_type
  *   - product_collection
  *   - product_handle
@@ -213,6 +214,10 @@
  *     type: number
  *     title: refundable_total_per_unit
  *     description: The total refundable amount of the item's total for a single quantity.
+ *   product_type_id:
+ *     type: string
+ *     title: product_type_id
+ *     description: The item's product type id.
  * 
 */
 

www/utils/generated/oas-output/schemas/BaseCollection.ts

@@ -43,7 +43,7 @@
  *     type: array
  *     description: The collection's products.
  *     items:
- *       $ref: "#/components/schemas/AdminProduct"
+ *       $ref: "#/components/schemas/BaseProduct"
  *   metadata:
  *     type: object
  *     description: The collection's metadata, used to store custom key-value pairs.

www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts

@@ -13,6 +13,7 @@
  *   - product_title
  *   - product_description
  *   - product_subtitle
+ *   - product_type_id
  *   - product_type
  *   - product_collection
  *   - product_handle
@@ -213,6 +214,10 @@
  *     type: number
  *     title: refundable_total_per_unit
  *     description: The total refundable amount of the item's total for a single quantity.
+ *   product_type_id:
+ *     type: string
+ *     title: product_type_id
+ *     description: The item's product type id.
  * 
 */
 

www/utils/generated/oas-output/schemas/BaseProduct.ts

@@ -31,30 +31,33 @@
  *   - updated_at
  *   - deleted_at
  * properties:
- *   id:
+ *   collection:
- *     type: string
+ *     $ref: "#/components/schemas/BaseCollection"
- *     title: id
+ *   categories:
- *     description: The product's ID.
+ *     type: array
+ *     description: The product's categories.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductCategory"
+ *   variants:
+ *     type: array
+ *     description: The product's variants.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductVariant"
+ *   type:
+ *     $ref: "#/components/schemas/BaseProductType"
+ *   tags:
+ *     type: array
+ *     description: The product's tags.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductTag"
+ *   length:
+ *     type: number
+ *     title: length
+ *     description: The product's length.
  *   title:
  *     type: string
  *     title: title
  *     description: The product's title.
- *   handle:
- *     type: string
- *     title: handle
- *     description: The product's handle.
- *   subtitle:
- *     type: string
- *     title: subtitle
- *     description: The product's subtitle.
- *   description:
- *     type: string
- *     title: description
- *     description: The product's description.
- *   is_giftcard:
- *     type: boolean
- *     title: is_giftcard
- *     description: Whether the product is a gift card.
  *   status:
  *     type: string
  *     description: The product's status.
@@ -63,10 +66,48 @@
  *       - proposed
  *       - published
  *       - rejected
+ *   options:
+ *     type: array
+ *     description: The product's options.
+ *     items:
+ *       $ref: "#/components/schemas/BaseProductOption"
+ *   description:
+ *     type: string
+ *     title: description
+ *     description: The product's description.
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The product's ID.
+ *   metadata:
+ *     type: object
+ *     description: The product's metadata, can hold custom key-value pairs.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the product was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the product was updated.
+ *   handle:
+ *     type: string
+ *     title: handle
+ *     description: The product's unique handle.
+ *   subtitle:
+ *     type: string
+ *     title: subtitle
+ *     description: The product's subtitle.
+ *   is_giftcard:
+ *     type: boolean
+ *     title: is_giftcard
+ *     description: Whether the product is a gift card.
  *   thumbnail:
  *     type: string
  *     title: thumbnail
- *     description: The product's thumbnail URL.
+ *     description: The product's thumbnail.
  *   width:
  *     type: number
  *     title: width
@@ -75,10 +116,6 @@
  *     type: number
  *     title: weight
  *     description: The product's weight.
- *   length:
- *     type: number
- *     title: length
- *     description: The product's length.
  *   height:
  *     type: number
  *     title: height
@@ -90,47 +127,23 @@
  *   hs_code:
  *     type: string
  *     title: hs_code
- *     description: The product's hs code.
+ *     description: The product's HS code.
  *   mid_code:
  *     type: string
  *     title: mid_code
- *     description: The product's mid code.
+ *     description: The product's MID code.
  *   material:
  *     type: string
  *     title: material
  *     description: The product's material.
- *   collection:
- *     $ref: "#/components/schemas/BaseCollection"
  *   collection_id:
  *     type: string
  *     title: collection_id
- *     description: The ID of the collection the product belongs to.
+ *     description: The ID of the collection that the product belongs to.
- *   categories:
- *     type: array
- *     description: The product's categories.
- *     items:
- *       $ref: "#/components/schemas/BaseProductCategory"
- *   type:
- *     $ref: "#/components/schemas/BaseProductType"
  *   type_id:
  *     type: string
  *     title: type_id
- *     description: The ID of the type the product belongs to.
+ *     description: The ID of the product's type.
- *   tags:
- *     type: array
- *     description: The product's tags.
- *     items:
- *       $ref: "#/components/schemas/BaseProductTag"
- *   variants:
- *     type: array
- *     description: The product's variants.
- *     items:
- *       $ref: "#/components/schemas/BaseProductVariant"
- *   options:
- *     type: array
- *     description: The product's options.
- *     items:
- *       $ref: "#/components/schemas/BaseProductOption"
  *   images:
  *     type: array
  *     description: The product's images.
@@ -139,29 +152,16 @@
  *   discountable:
  *     type: boolean
  *     title: discountable
- *     description: Whether the product is discountable.
+ *     description: Whether discounts can be applied on the product.
  *   external_id:
  *     type: string
  *     title: external_id
- *     description: The ID of the product in an external or third-party system.
+ *     description: The ID of a product in an external system, such as an ERP or CMS.
- *   created_at:
- *     type: string
- *     format: date-time
- *     title: created_at
- *     description: The date the product was created.
- *   updated_at:
- *     type: string
- *     format: date-time
- *     title: updated_at
- *     description: The date the product was updated.
  *   deleted_at:
  *     type: string
  *     format: date-time
  *     title: deleted_at
  *     description: The date the product was deleted.
- *   metadata:
- *     type: object
- *     description: The product's metadata, can hold custom key-value pairs.
  * 
 */
 

www/utils/generated/oas-output/schemas/BaseProductCategory.ts

@@ -22,14 +22,14 @@
  *     type: array
  *     description: The category's children.
  *     items:
- *       $ref: "#/components/schemas/BaseProductCategory"
+ *       $ref: "#/components/schemas/AdminProductCategory"
  *   parent_category:
- *     $ref: "#/components/schemas/BaseProductCategory"
+ *     $ref: "#/components/schemas/AdminProductCategory"
  *   products:
  *     type: array
  *     description: The category's products.
  *     items:
- *       $ref: "#/components/schemas/BaseProduct"
+ *       $ref: "#/components/schemas/AdminProduct"
  *   name:
  *     type: string
  *     title: name

www/utils/generated/oas-output/schemas/Order.ts

@@ -6,6 +6,7 @@
  * required:
  *   - id
  *   - version
+ *   - display_id
  *   - status
  *   - currency_code
  *   - created_at
@@ -208,6 +209,10 @@
  *     type: number
  *     title: original_shipping_tax_total
  *     description: The total taxes of the order's shipping excluding promotions.
+ *   display_id:
+ *     type: number
+ *     title: display_id
+ *     description: The order's display id.
  * 
 */
 

www/utils/generated/oas-output/schemas/OrderExchange.ts

@@ -25,8 +25,19 @@
  *     title: no_notification
  *     description: Whether to send the customer notifications when the exchange is updated.
  *   difference_due:
- *     type: number
+ *     oneOf:
- *     title: difference_due
+ *       - type: string
+ *         title: difference_due
+ *         description: The exchange's difference due.
+ *       - type: number
+ *         title: difference_due
+ *         description: The exchange's difference due.
+ *       - type: string
+ *         title: difference_due
+ *         description: The exchange's difference due.
+ *       - type: number
+ *         title: difference_due
+ *         description: The exchange's difference due.
  *     description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
  *   return:
  *     $ref: "#/components/schemas/Return"

www/utils/generated/oas-output/schemas/OrderLineItem.ts

@@ -194,6 +194,10 @@
  *     type: number
  *     title: refundable_total_per_unit
  *     description: The total amount that can be refunded of a single quantity of the item.
+ *   product_type_id:
+ *     type: string
+ *     title: product_type_id
+ *     description: The item's product type id.
  * 
 */
 

www/utils/generated/oas-output/schemas/Return.ts

@@ -24,8 +24,19 @@
  *       - received
  *       - partially_received
  *   refund_amount:
- *     type: number
+ *     oneOf:
- *     title: refund_amount
+ *       - type: string
+ *         title: refund_amount
+ *         description: The return order's refund amount.
+ *       - type: number
+ *         title: refund_amount
+ *         description: The return order's refund amount.
+ *       - type: string
+ *         title: refund_amount
+ *         description: The return order's refund amount.
+ *       - type: number
+ *         title: refund_amount
+ *         description: The return order's refund amount.
  *     description: The amount refunded by this return.
  *   order_id:
  *     type: string

www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts

@@ -28,6 +28,7 @@
  *   - product_title
  *   - product_description
  *   - product_subtitle
+ *   - product_type_id
  *   - product_type
  *   - product_collection
  *   - product_handle
@@ -4011,6 +4012,10 @@
  *     type: number
  *     title: refundable_total_per_unit
  *     description: The total refundable amount of the item's total for a single quantity.
+ *   product_type_id:
+ *     type: string
+ *     title: product_type_id
+ *     description: The item's product type id.
  * 
 */
 

www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts

@@ -20,6 +20,9 @@
  *     type: string
  *     title: phone
  *     description: The customer's phone.
+ *   metadata:
+ *     type: object
+ *     description: The customer's metadata.
  * 
 */