docs: generate OAS for 2.11.2 (#13925)

www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml

@@ -39,23 +39,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The sales channels to add or remove from the publishable API key.
-          properties:
-            add:
-              type: array
-              description: The sales channels to add to the publishable API key.
-              items:
-                type: string
-                title: add
-                description: A sales channel's ID.
-            remove:
-              type: array
-              description: The sales channels to remove from the publishable API key.
-              items:
-                type: string
-                title: remove
-                description: A sales channel's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -65,6 +65,63 @@ get:
         type: boolean
         title: with_deleted
         description: Whether to include deleted records in the result.
+    - name: q
+      in: query
+      description: Apply a search query to the campaign's searchable properties.
+      required: false
+      schema:
+        type: string
+        title: q
+        description: Apply a search query to the campaign's searchable properties.
+    - name: campaign_identifier
+      in: query
+      description: Filter by a campaign identifier.
+      required: false
+      schema:
+        type: string
+        title: campaign_identifier
+        description: Filter by a campaign identifier.
+    - name: budget
+      in: query
+      description: Filter by the campaign's budget.
+      required: false
+      schema:
+        type: object
+        description: Filter by the campaign's budget.
+        properties:
+          currency_code:
+            type: string
+            title: currency_code
+            description: The budget's currency code.
+            example: usd
+    - name: $and
+      in: query
+      description: >-
+        Join query parameters with an AND condition. Each object's content is
+        the same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an AND condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $and
+    - name: $or
+      in: query
+      description: >-
+        Join query parameters with an OR condition. Each object's content is the
+        same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an OR condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $or
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml

@@ -39,23 +39,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The promotions to add or remove from the campaign.
-          properties:
-            add:
-              type: array
-              description: The promotions to add to the campaign.
-              items:
-                type: string
-                title: add
-                description: A promotion's ID.
-            remove:
-              type: array
-              description: The promotions to remove from the campaign.
-              items:
-                type: string
-                title: remove
-                description: A promotion's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -59,11 +59,11 @@ get:
           with `-`.
     - name: deleted_at
       in: query
-      description: The claim's deleted at.
+      description: Filter by the claim's deletion date.
       required: false
       schema:
         type: object
-        description: The claim's deleted at.
+        description: The claim's deletion date.
         properties:
           $and:
             type: array
@@ -383,20 +383,20 @@ get:
         oneOf:
           - type: string
             title: status
-            description: The claim's status.
+            description: Filter by the claim's status.
           - type: array
-            description: The claim's status.
+            description: Filter by the claim's status.
             items:
               type: string
               title: status
-              description: The status's details.
+              description: The claim's status.
     - name: created_at
       in: query
-      description: The claim's created at.
+      description: Filter by the claim's creation date.
       required: false
       schema:
         type: object
-        description: The claim's created at.
+        description: The claim's creation date.
         properties:
           $and:
             type: array
@@ -675,11 +675,11 @@ get:
             description: Filter by whether a value for this parameter exists (not `null`).
     - name: updated_at
       in: query
-      description: The claim's updated at.
+      description: Filter by the claim's update date.
       required: false
       schema:
         type: object
-        description: The claim's updated at.
+        description: The claim's update date.
         properties:
           $and:
             type: array
@@ -1052,6 +1052,451 @@ post:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: id
+            description: Filter by the claim's ID.
+          - type: array
+            description: Filter by multiple claim IDs.
+            items:
+              type: string
+              title: id
+              description: A claim ID.
+    - name: status
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: status
+            description: Filter by the claim's status.
+          - type: array
+            description: Filter by multiple claim statuses.
+            items:
+              type: string
+              title: status
+              description: A claim status.
+    - name: created_at
+      in: query
+      description: Filter by a claim's creation date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a claim's creation date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: updated_at
+      in: query
+      description: Filter by a claim's update date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a claim's update date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: deleted_at
+      in: query
+      description: Filter by a claim's deletion date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a claim's deletion date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
   security:
     - api_token: []
     - cookie_auth: []
@@ -1060,7 +1505,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostOrderClaimsReqSchema.yaml
+          $ref: ../components/schemas/AdminCreateClaim.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminAddClaimItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml

@@ -49,7 +49,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateClaimItem.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
+          $ref: ../components/schemas/AdminClaimUpdateInboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsAddItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminAddClaimOutboundItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsItemsActionReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateClaimOutboundItem.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsShippingReqSchema.yaml
+          $ref: ../components/schemas/AdminClaimAddOutboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostClaimsShippingActionReqSchema.yaml
+          $ref: ../components/schemas/AdminClaimUpdateOutboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml

@@ -39,23 +39,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The products to add or remove.
-          properties:
-            add:
-              type: array
-              description: The products to add to the collection.
-              items:
-                type: string
-                title: add
-                description: A product's ID.
-            remove:
-              type: array
-              description: The products to remove from the collection.
-              items:
-                type: string
-                title: remove
-                description: A product's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml

@@ -37,23 +37,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The customers to add or remove from the group.
-          properties:
-            add:
-              type: array
-              description: The customers to add to the group.
-              items:
-                type: string
-                title: add
-                description: A customer's ID.
-            remove:
-              type: array
-              description: The customers to remove from the group.
-              items:
-                type: string
-                title: remove
-                description: A customer's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -51,23 +51,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: SUMMARY
-          properties:
-            add:
-              type: array
-              description: The customer groups to add the customer to.
-              items:
-                type: string
-                title: add
-                description: The ID of the group to add the customer to.
-            remove:
-              type: array
-              description: The customer groups to remove the customer from.
-              items:
-                type: string
-                title: remove
-                description: The ID of the group to remove the customer from.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_convert-to-order.yaml

@@ -13,26 +13,6 @@ post:
       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: []
@@ -52,6 +32,10 @@ post:
   responses:
     '200':
       description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminOrderResponse.yaml
     '400':
       $ref: ../components/responses/400_error.yaml
     '401':
@@ -79,3 +63,8 @@ post:
 
         order.
       deprecated: false
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/AdminDraftOrderParams.yaml

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

@@ -1013,7 +1013,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostOrderExchangesReqSchema.yaml
+          $ref: ../components/schemas/AdminCreateExchange.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml

@@ -13,6 +13,24 @@ post:
       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: []
@@ -21,8 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: >-
-            ../components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminAddExchangeInboundItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
+          $ref: ../components/schemas/AdminExchangeUpdateInboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items.yaml

@@ -38,7 +38,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostExchangesAddItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminAddExchangeOutboundItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostExchangesItemsActionReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateExchangeOutboundItem.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostExchangesShippingReqSchema.yaml
+          $ref: ../components/schemas/AdminExchangeAddOutboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostExchangesShippingActionReqSchema.yaml
+          $ref: ../components/schemas/AdminExchangeUpdateOutboundShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml

@@ -37,7 +37,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreateFulfillmentSetServiceZones.yaml
+          $ref: ../components/schemas/AdminCreateFulfillmentSetServiceZone.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml

@@ -116,7 +116,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminUpdateFulfillmentSetServiceZones.yaml
+          $ref: ../components/schemas/AdminUpdateFulfillmentSetServiceZone.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreateShipment.yaml
+          $ref: ../components/schemas/AdminCreateFulfillmentShipment.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -0,0 +1,40 @@
+get:
+  operationId: GetIndexDetails
+  summary: Get Index Details
+  description: >-
+    Retrieve index metadata, including entity type, status, last synced key, and
+    last updated timestamp.
+  x-authenticated: true
+  parameters: []
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_index_details/get.sh
+  tags:
+    - Index
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminIndexDetailsResponse.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-since: 2.11.2
+  x-featureFlag: index

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

@@ -0,0 +1,39 @@
+post:
+  operationId: PostIndexSync
+  summary: Trigger Index Sync
+  description: Trigger reindexing or re-ingestion of the Index Module.
+  x-authenticated: true
+  parameters: []
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/AdminIndexSyncPayload.yaml
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_index_sync/post.sh
+  tags:
+    - Index
+  responses:
+    '200':
+      description: OK
+    '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-since: 2.11.2
+  x-featureFlag: index

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

@@ -64,28 +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: $and
-      in: query
-      required: false
-      schema:
-        type: array
-        description: >-
-          Join query parameters with an AND condition. Each object's content is
-          the same type as the expected query parameters.
-        items:
-          type: object
-        title: $and
-    - name: $or
-      in: query
-      required: false
-      schema:
-        type: array
-        description: >-
-          Join query parameters with an OR condition. Each object's content is
-          the same type as the expected query parameters.
-        items:
-          type: object
-        title: $or
     - name: with_deleted
       in: query
       description: Whether to include deleted records in the result.
@@ -94,6 +72,20 @@ get:
         type: boolean
         title: with_deleted
         description: Whether to include deleted records in the result.
+    - name: location_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: location_id
+            description: Filter by the inventory item's location ID.
+          - type: array
+            description: The inventory item's location IDs.
+            items:
+              type: string
+              title: location_id
+              description: The location ID.
   security:
     - api_token: []
     - cookie_auth: []
@@ -200,7 +192,8 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreateInventoryLocationLevel.yaml
+          $ref: >-
+            ../components/schemas/AdminBatchCreateInventoryItemLocationLevels.yaml
   x-codeSamples:
     - lang: Shell
       label: cURL

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

@@ -45,7 +45,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminUpdateInventoryLocationLevel.yaml
+          $ref: ../components/schemas/AdminUpdateInventoryLevel.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml

@@ -30,34 +30,6 @@ get:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
-    - name: id
-      in: query
-      required: false
-      schema:
-        oneOf:
-          - type: string
-            title: id
-            description: The order's ID.
-          - type: array
-            description: The order's ID.
-            items:
-              type: string
-              title: id
-              description: The id's ID.
-    - name: status
-      in: query
-      required: false
-      schema:
-        oneOf:
-          - type: string
-            title: status
-            description: The order's status.
-          - type: array
-            description: The order's status.
-            items:
-              type: string
-              title: status
-              description: The status's details.
     - name: version
       in: query
       description: The order's version.
@@ -66,18 +38,6 @@ get:
         type: number
         title: version
         description: The order's version.
-    - name: created_at
-      in: query
-      required: false
-      schema: {}
-    - name: updated_at
-      in: query
-      required: false
-      schema: {}
-    - name: deleted_at
-      in: query
-      required: false
-      schema: {}
   security:
     - api_token: []
     - cookie_auth: []
@@ -146,6 +106,14 @@ post:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: version
+      in: query
+      description: The version of the order to retrieve.
+      required: false
+      schema:
+        type: number
+        title: version
+        description: The version of the order to retrieve.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml

@@ -7,7 +7,7 @@ get:
     etc...
 
 
-    The changes can be filtered by fields like FILTER FIELDS. The changes can
+    The changes can be filtered by fields like `created_at`. The changes can
     also be paginated.
   x-authenticated: true
   parameters:
@@ -37,6 +37,940 @@ get:
           fields, using `-` will remove it from the default fields.
 
           without prefix it will replace the entire default fields.
+    - name: created_at
+      in: query
+      description: Filter by the order change's creation date.
+      required: false
+      schema:
+        type: object
+        description: Filter by the order change's creation date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by multiple exact matches.
+                items:
+                  type: string
+                  title: $eq
+                  description: An exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: The value to match.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: The value not to match.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: Filter by values not matching this parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                properties:
+                  $and:
+                    type: array
+                    description: >-
+                      Join query parameters with an AND condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $and
+                  $or:
+                    type: array
+                    description: >-
+                      Join query parameters with an OR condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $or
+                  $eq:
+                    oneOf:
+                      - type: string
+                        title: $eq
+                        description: Filter by an exact match.
+                      - type: array
+                        description: Filter by multiple exact matches.
+                        items:
+                          type: string
+                          title: $eq
+                          description: The value to match.
+                  $ne:
+                    type: string
+                    title: $ne
+                    description: Filter by values not matching this parameter.
+                  $in:
+                    type: array
+                    description: Filter by values in this array.
+                    items:
+                      type: string
+                      title: $in
+                      description: The value to match.
+                  $nin:
+                    type: array
+                    description: Filter by values not in this array.
+                    items:
+                      type: string
+                      title: $nin
+                      description: The value to not match
+                  $not:
+                    oneOf:
+                      - type: string
+                        title: $not
+                        description: Filter by values not matching this parameter
+                      - type: object
+                        description: >-
+                          Filter by values not matching the conditions in this
+                          parameter.
+                      - type: array
+                        description: >-
+                          Filter by values not matching the values of this
+                          parameter.
+                        items:
+                          type: string
+                          title: $not
+                          description: The values to not match.
+                  $gt:
+                    type: string
+                    title: $gt
+                    description: >-
+                      Filter by values greater than this parameter. Useful for
+                      numbers and dates only.
+                  $gte:
+                    type: string
+                    title: $gte
+                    description: >-
+                      Filter by values greater than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $lt:
+                    type: string
+                    title: $lt
+                    description: >-
+                      Filter by values less than this parameter. Useful for
+                      numbers and dates only.
+                  $lte:
+                    type: string
+                    title: $lte
+                    description: >-
+                      Filter by values less than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $like:
+                    type: string
+                    title: $like
+                    description: Apply a `like` filter. Useful for strings only.
+                  $re:
+                    type: string
+                    title: $re
+                    description: Apply a regex filter. Useful for strings only.
+                  $ilike:
+                    type: string
+                    title: $ilike
+                    description: >-
+                      Apply a case-insensitive `like` filter. Useful for strings
+                      only.
+                  $fulltext:
+                    type: string
+                    title: $fulltext
+                    description: Filter to apply on full-text properties.
+                  $overlap:
+                    type: array
+                    description: >-
+                      Filter arrays that have overlapping values with this
+                      parameter.
+                    items:
+                      type: string
+                      title: $overlap
+                      description: The value to match.
+                  $contains:
+                    type: array
+                    description: >-
+                      Filter arrays that contain some of the values of this
+                      parameter.
+                    items:
+                      type: string
+                      title: $contains
+                      description: The values to match.
+                  $contained:
+                    type: array
+                    description: Filter arrays that contain all values of this parameter.
+                    items:
+                      type: string
+                      title: $contained
+                      description: The values to match.
+                  $exists:
+                    type: boolean
+                    title: $exists
+                    description: >-
+                      Filter by whether a value for this parameter exists (not
+                      `null`).
+              - type: array
+                description: Filter by values not matching those in this parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: The values to not match.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: The values to match.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: The values to match.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: The values to match.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: updated_at
+      in: query
+      description: Filter by the order change's update date.
+      required: false
+      schema:
+        type: object
+        description: Filter by the order change's update date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by multiple exact matches.
+                items:
+                  type: string
+                  title: $eq
+                  description: An exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: The value to match.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: The value not to match.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: Filter by values not matching this parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                properties:
+                  $and:
+                    type: array
+                    description: >-
+                      Join query parameters with an AND condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $and
+                  $or:
+                    type: array
+                    description: >-
+                      Join query parameters with an OR condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $or
+                  $eq:
+                    oneOf:
+                      - type: string
+                        title: $eq
+                        description: Filter by an exact match.
+                      - type: array
+                        description: Filter by multiple exact matches.
+                        items:
+                          type: string
+                          title: $eq
+                          description: The value to match.
+                  $ne:
+                    type: string
+                    title: $ne
+                    description: Filter by values not matching this parameter.
+                  $in:
+                    type: array
+                    description: Filter by values in this array.
+                    items:
+                      type: string
+                      title: $in
+                      description: The value to match.
+                  $nin:
+                    type: array
+                    description: Filter by values not in this array.
+                    items:
+                      type: string
+                      title: $nin
+                      description: The value to not match
+                  $not:
+                    oneOf:
+                      - type: string
+                        title: $not
+                        description: Filter by values not matching this parameter
+                      - type: object
+                        description: >-
+                          Filter by values not matching the conditions in this
+                          parameter.
+                      - type: array
+                        description: >-
+                          Filter by values not matching the values of this
+                          parameter.
+                        items:
+                          type: string
+                          title: $not
+                          description: The values to not match.
+                  $gt:
+                    type: string
+                    title: $gt
+                    description: >-
+                      Filter by values greater than this parameter. Useful for
+                      numbers and dates only.
+                  $gte:
+                    type: string
+                    title: $gte
+                    description: >-
+                      Filter by values greater than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $lt:
+                    type: string
+                    title: $lt
+                    description: >-
+                      Filter by values less than this parameter. Useful for
+                      numbers and dates only.
+                  $lte:
+                    type: string
+                    title: $lte
+                    description: >-
+                      Filter by values less than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $like:
+                    type: string
+                    title: $like
+                    description: Apply a `like` filter. Useful for strings only.
+                  $re:
+                    type: string
+                    title: $re
+                    description: Apply a regex filter. Useful for strings only.
+                  $ilike:
+                    type: string
+                    title: $ilike
+                    description: >-
+                      Apply a case-insensitive `like` filter. Useful for strings
+                      only.
+                  $fulltext:
+                    type: string
+                    title: $fulltext
+                    description: Filter to apply on full-text properties.
+                  $overlap:
+                    type: array
+                    description: >-
+                      Filter arrays that have overlapping values with this
+                      parameter.
+                    items:
+                      type: string
+                      title: $overlap
+                      description: The value to match.
+                  $contains:
+                    type: array
+                    description: >-
+                      Filter arrays that contain some of the values of this
+                      parameter.
+                    items:
+                      type: string
+                      title: $contains
+                      description: The values to match.
+                  $contained:
+                    type: array
+                    description: Filter arrays that contain all values of this parameter.
+                    items:
+                      type: string
+                      title: $contained
+                      description: The values to match.
+                  $exists:
+                    type: boolean
+                    title: $exists
+                    description: >-
+                      Filter by whether a value for this parameter exists (not
+                      `null`).
+              - type: array
+                description: Filter by values not matching those in this parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: The values to not match.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: The values to match.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: The values to match.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: The values to match.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: deleted_at
+      in: query
+      description: Filter by the order change's deletion date.
+      required: false
+      schema:
+        type: object
+        description: Filter by the order change's deletion date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by multiple exact matches.
+                items:
+                  type: string
+                  title: $eq
+                  description: An exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: The value to match.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: The value not to match.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: Filter by values not matching this parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                properties:
+                  $and:
+                    type: array
+                    description: >-
+                      Join query parameters with an AND condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $and
+                  $or:
+                    type: array
+                    description: >-
+                      Join query parameters with an OR condition. Each object's
+                      content is the same type as the expected query parameters.
+                    items:
+                      type: object
+                    title: $or
+                  $eq:
+                    oneOf:
+                      - type: string
+                        title: $eq
+                        description: Filter by an exact match.
+                      - type: array
+                        description: Filter by multiple exact matches.
+                        items:
+                          type: string
+                          title: $eq
+                          description: The value to match.
+                  $ne:
+                    type: string
+                    title: $ne
+                    description: Filter by values not matching this parameter.
+                  $in:
+                    type: array
+                    description: Filter by values in this array.
+                    items:
+                      type: string
+                      title: $in
+                      description: The value to match.
+                  $nin:
+                    type: array
+                    description: Filter by values not in this array.
+                    items:
+                      type: string
+                      title: $nin
+                      description: The value to not match
+                  $not:
+                    oneOf:
+                      - type: string
+                        title: $not
+                        description: Filter by values not matching this parameter
+                      - type: object
+                        description: >-
+                          Filter by values not matching the conditions in this
+                          parameter.
+                      - type: array
+                        description: >-
+                          Filter by values not matching the values of this
+                          parameter.
+                        items:
+                          type: string
+                          title: $not
+                          description: The values to not match.
+                  $gt:
+                    type: string
+                    title: $gt
+                    description: >-
+                      Filter by values greater than this parameter. Useful for
+                      numbers and dates only.
+                  $gte:
+                    type: string
+                    title: $gte
+                    description: >-
+                      Filter by values greater than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $lt:
+                    type: string
+                    title: $lt
+                    description: >-
+                      Filter by values less than this parameter. Useful for
+                      numbers and dates only.
+                  $lte:
+                    type: string
+                    title: $lte
+                    description: >-
+                      Filter by values less than or equal to this parameter.
+                      Useful for numbers and dates only.
+                  $like:
+                    type: string
+                    title: $like
+                    description: Apply a `like` filter. Useful for strings only.
+                  $re:
+                    type: string
+                    title: $re
+                    description: Apply a regex filter. Useful for strings only.
+                  $ilike:
+                    type: string
+                    title: $ilike
+                    description: >-
+                      Apply a case-insensitive `like` filter. Useful for strings
+                      only.
+                  $fulltext:
+                    type: string
+                    title: $fulltext
+                    description: Filter to apply on full-text properties.
+                  $overlap:
+                    type: array
+                    description: >-
+                      Filter arrays that have overlapping values with this
+                      parameter.
+                    items:
+                      type: string
+                      title: $overlap
+                      description: The value to match.
+                  $contains:
+                    type: array
+                    description: >-
+                      Filter arrays that contain some of the values of this
+                      parameter.
+                    items:
+                      type: string
+                      title: $contains
+                      description: The values to match.
+                  $contained:
+                    type: array
+                    description: Filter arrays that contain all values of this parameter.
+                    items:
+                      type: string
+                      title: $contained
+                      description: The values to match.
+                  $exists:
+                    type: boolean
+                    title: $exists
+                    description: >-
+                      Filter by whether a value for this parameter exists (not
+                      `null`).
+              - type: array
+                description: Filter by values not matching those in this parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: The values to not match.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: The values to match.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: The values to match.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: The values to match.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: id
+            description: Filter by an order change ID.
+          - type: array
+            description: Filter by order change IDs.
+            items:
+              type: string
+              title: id
+              description: An order change ID.
+          - type: object
+            description: The order's ID.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+    - name: status
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: status
+            description: Filter by the order change's status.
+          - type: array
+            description: Filter by multiple order change statuses.
+            items:
+              type: string
+              title: status
+              description: An order change status.
+          - type: object
+            description: The order change's status.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+    - name: change_type
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: change_type
+            description: Filter by the order change's type.
+          - type: array
+            description: Filter by multiple order change types.
+            items:
+              type: string
+              title: change_type
+              description: An order change type.
+          - type: object
+            description: Filter the order change's type.
+            properties:
+              $and:
+                type: array
+                description: >-
+                  Join query parameters with an AND condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $and
+              $or:
+                type: array
+                description: >-
+                  Join query parameters with an OR condition. Each object's
+                  content is the same type as the expected query parameters.
+                items:
+                  type: object
+                title: $or
+    - name: $and
+      in: query
+      description: >-
+        Join query parameters with an AND condition. Each object's content is
+        the same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an AND condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $and
+    - name: $or
+      in: query
+      description: >-
+        Join query parameters with an OR condition. Each object's content is the
+        same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an OR condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $or
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_credit-lines.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreateOrderCreditLines.yaml
+          $ref: ../components/schemas/AdminCreateOrderCreditLine.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml

@@ -18,24 +18,6 @@ post:
       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: []

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml

@@ -74,41 +74,6 @@ get:
               type: number
               title: version
               description: The version's details.
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-        externalDocs:
-          url: '#pagination'
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-        externalDocs:
-          url: '#pagination'
-    - name: order
-      in: query
-      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 `-`.
-      required: false
-      schema:
-        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 `-`.
-        externalDocs:
-          url: '#pagination'
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_orders_{id}_transfer.yaml

@@ -43,7 +43,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminTransferOrder.yaml
+          $ref: ../components/schemas/AdminRequestOrderTransfer.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminMarkPaymentCollectionPaid.yaml
+          $ref: ../components/schemas/AdminMarkPaymentCollectionAsPaid.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml

@@ -38,7 +38,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreatePaymentCapture.yaml
+          $ref: ../components/schemas/AdminCapturePayment.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml

@@ -38,7 +38,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminCreatePaymentRefund.yaml
+          $ref: ../components/schemas/AdminRefundPayment.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml

@@ -475,6 +475,401 @@ post:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: q
+      in: query
+      description: Apply a search query to the price list's searchable properties.
+      required: false
+      schema:
+        type: string
+        title: q
+        description: Apply a search query to the price list's searchable properties.
+    - name: id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: id
+            description: Filter by a specific price list ID.
+          - type: array
+            description: Filter by multiple price list IDs.
+            items:
+              type: string
+              title: id
+              description: A price list ID.
+    - name: starts_at
+      in: query
+      description: Filter by a price list's start date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a price list's start date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: ends_at
+      in: query
+      description: Filter by a price list's end date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a price list's end date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: status
+      in: query
+      description: Filter by price list statuses.
+      required: false
+      schema:
+        type: array
+        description: Filter by price list statuses.
+        items:
+          type: string
+          description: A price list status.
+          enum:
+            - draft
+            - active
+    - name: rules_count
+      in: query
+      description: Filter by multiple price list rules count.
+      required: false
+      schema:
+        type: array
+        description: Filter by price list rules count.
+        items:
+          type: number
+          title: rules_count
+          description: A price list's rules count.
+    - name: limit
+      in: query
+      description: Limit the number of items returned in the list.
+      required: false
+      schema:
+        type: number
+        title: limit
+        description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
+    - name: offset
+      in: query
+      description: The number of items to skip when retrieving a list.
+      required: false
+      schema:
+        type: number
+        title: offset
+        description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
+    - name: order
+      in: query
+      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 `-`.
+      required: false
+      schema:
+        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 `-`.
+        externalDocs:
+          url: '#pagination'
+    - name: with_deleted
+      in: query
+      description: The price list's with deleted.
+      required: false
+      schema:
+        type: boolean
+        title: with_deleted
+        description: The price list's with deleted.
+    - name: $and
+      in: query
+      description: >-
+        Join query parameters with an AND condition. Each object's content is
+        the same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an AND condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $and
+    - name: $or
+      in: query
+      description: >-
+        Join query parameters with an OR condition. Each object's content is the
+        same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an OR condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $or
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml

@@ -717,49 +717,46 @@ post:
           documentation.
         externalDocs:
           url: '#select-fields-and-relations'
-    - name: offset
-      in: query
-      description: The number of items to skip when retrieving a list.
-      required: false
-      schema:
-        type: number
-        title: offset
-        description: The number of items to skip when retrieving a list.
-        externalDocs:
-          url: '#pagination'
-    - name: limit
-      in: query
-      description: Limit the number of items returned in the list.
-      required: false
-      schema:
-        type: number
-        title: limit
-        description: Limit the number of items returned in the list.
-        externalDocs:
-          url: '#pagination'
-    - name: order
+    - name: include_ancestors_tree
       in: query
       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 `-`.
-      required: false
-      schema:
-        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 `-`.
-        externalDocs:
-          url: '#pagination'
-    - name: with_deleted
-      in: query
-      description: Whether to include deleted records in the result.
+        Whether to retrieve the category's parent. If you enable this, add to
+        the `fields` query parameter `parent_category` to set the parent of a
+        category in this field. You can either pass `*parent_category` to
+        retreieve the fields of all parent categories, or select specific fields
+        to make the response size smaller. For example,
+        `fields=parent_category.id,parent_category.name`.
       required: false
       schema:
         type: boolean
-        title: with_deleted
-        description: Whether to include deleted records in the result.
+        title: include_ancestors_tree
+        description: >-
+          Whether to retrieve the category's parent. If you enable this, add to
+          the `fields` query parameter `parent_category` to set the parent of a
+          category in this field. You can either pass `*parent_category` to
+          retreieve the fields of all parent categories, or select specific
+          fields to make the response size smaller. For example,
+          `fields=parent_category.id,parent_category.name`.
+    - name: include_descendants_tree
+      in: query
+      description: >-
+        Whether to retrieve a list of child categories. If you enable this, add
+        to the `fields` query parameter `category_children` to set the child of
+        a category in this field. You can either pass `*category_children` to
+        retreieve the fields of all child categories, or select specific fields
+        to make the response size smaller. For example,
+        `fields=category_children.id,category_children.name`.
+      required: false
+      schema:
+        type: boolean
+        title: include_descendants_tree
+        description: >-
+          Whether to retrieve a list of child categories. If you enable this,
+          add to the `fields` query parameter `category_children` to set the
+          child of a category in this field. You can either pass
+          `*category_children` to retreieve the fields of all child categories,
+          or select specific fields to make the response size smaller. For
+          example, `fields=category_children.id,category_children.name`.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml

@@ -37,6 +37,46 @@ post:
           documentation.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: include_ancestors_tree
+      in: query
+      description: >-
+        Whether to retrieve the category's parent. If you enable this, add to
+        the `fields` query parameter `parent_category` to set the parent of a
+        category in this field. You can either pass `*parent_category` to
+        retreieve the fields of all parent categories, or select specific fields
+        to make the response size smaller. For example,
+        `fields=parent_category.id,parent_category.name`.
+      required: false
+      schema:
+        type: boolean
+        title: include_ancestors_tree
+        description: >-
+          Whether to retrieve the category's parent. If you enable this, add to
+          the `fields` query parameter `parent_category` to set the parent of a
+          category in this field. You can either pass `*parent_category` to
+          retreieve the fields of all parent categories, or select specific
+          fields to make the response size smaller. For example,
+          `fields=parent_category.id,parent_category.name`.
+    - name: include_descendants_tree
+      in: query
+      description: >-
+        Whether to retrieve a list of child categories. If you enable this, add
+        to the `fields` query parameter `category_children` to set the child of
+        a category in this field. You can either pass `*category_children` to
+        retreieve the fields of all child categories, or select specific fields
+        to make the response size smaller. For example,
+        `fields=category_children.id,category_children.name`.
+      required: false
+      schema:
+        type: boolean
+        title: include_descendants_tree
+        description: >-
+          Whether to retrieve a list of child categories. If you enable this,
+          add to the `fields` query parameter `category_children` to set the
+          child of a category in this field. You can either pass
+          `*category_children` to retreieve the fields of all child categories,
+          or select specific fields to make the response size smaller. For
+          example, `fields=category_children.id,category_children.name`.
   security:
     - api_token: []
     - cookie_auth: []
@@ -45,23 +85,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The products to add or remove from the category.
-          properties:
-            add:
-              type: array
-              description: The products to add.
-              items:
-                type: string
-                title: add
-                description: A product ID.
-            remove:
-              type: array
-              description: The product to remove.
-              items:
-                type: string
-                title: remove
-                description: A product ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -848,7 +848,7 @@ get:
                   `null`).
           updated_at:
             type: object
-            description: The variant's updated at.
+            description: Filter by the variant's update date.
             properties:
               $and:
                 type: array
@@ -1183,35 +1183,47 @@ get:
             oneOf:
               - type: string
                 title: ean
-                description: The variant's ean.
+                description: Filter by a variant's ean.
               - type: array
-                description: The variant's ean.
+                description: Filter by variant eans.
                 items:
                   type: string
                   title: ean
-                  description: The ean's details.
+                  description: A variant's ean.
           upc:
             oneOf:
               - type: string
                 title: upc
-                description: The variant's upc.
+                description: Filter by a variant's upc.
               - type: array
-                description: The variant's upc.
+                description: Filter by variant upcs.
                 items:
                   type: string
                   title: upc
-                  description: The upc's details.
+                  description: A variant's upc.
           barcode:
             oneOf:
               - type: string
                 title: barcode
-                description: The variant's barcode.
+                description: Filter by a variant's barcode.
               - type: array
-                description: The variant's barcode.
+                description: Filter by variant barcodes.
                 items:
                   type: string
                   title: barcode
-                  description: The barcode's details.
+                  description: A variant's barcode.
+          with_deleted:
+            type: boolean
+            title: with_deleted
+            description: Whether to include deleted variants.
+    - name: with_deleted
+      in: query
+      description: Whether to include deleted products.
+      required: false
+      schema:
+        type: boolean
+        title: with_deleted
+        description: Whether to include deleted products.
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -32,6 +32,683 @@ post:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: tags
+      in: query
+      description: Filter products by their tags.
+      required: false
+      schema:
+        type: object
+        description: Filter products by their tags.
+        properties:
+          id:
+            type: array
+            description: Filter by tag IDs.
+            items:
+              type: string
+              title: id
+              description: A tag ID.
+    - name: variants
+      in: query
+      description: Filter the products' variants.
+      required: false
+      schema:
+        type: object
+        description: Filter the products' variants.
+        properties:
+          options:
+            type: object
+            description: Filter the variants by their options.
+            properties:
+              value:
+                type: string
+                title: value
+                description: The option's value.
+              option_id:
+                type: string
+                title: option_id
+                description: The option's ID.
+              option:
+                type: object
+                description: The option's details.
+    - name: title
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: title
+            description: Filter products by their title.
+          - type: array
+            description: Filter products by multiple titles.
+            items:
+              type: string
+              title: title
+              description: A product title.
+    - name: status
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: status
+            description: Filter products by their status.
+            enum:
+              - draft
+              - proposed
+              - published
+              - rejected
+          - type: array
+            description: Filter products by multiple statuses.
+            items:
+              type: string
+              description: A product status.
+              enum:
+                - draft
+                - proposed
+                - published
+                - rejected
+    - name: id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: id
+            description: Filter products by their ID.
+          - type: array
+            description: Filter products by multiple IDs.
+            items:
+              type: string
+              title: id
+              description: A product ID.
+    - name: sales_channel_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: sales_channel_id
+            description: Filter products by their sales channel ID.
+          - type: array
+            description: Filter products by multiple sales channel IDs.
+            items:
+              type: string
+              title: sales_channel_id
+              description: A sales channel ID.
+    - name: created_at
+      in: query
+      description: Filter by a product's creation date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a product's creation date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: updated_at
+      in: query
+      description: Filter by a product's update date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a product's update date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: handle
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: handle
+            description: Filter products by their handle.
+          - type: array
+            description: Filter products by multiple handles.
+            items:
+              type: string
+              title: handle
+              description: A product handle.
+    - name: is_giftcard
+      in: query
+      description: Filter products by whether they are gift cards.
+      required: false
+      schema:
+        type: boolean
+        title: is_giftcard
+        description: Whether the product is a gift card.
+    - name: collection_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: collection_id
+            description: Filter products by their collection ID.
+          - type: array
+            description: Filter products by multiple collection IDs.
+            items:
+              type: string
+              title: collection_id
+              description: A collection ID.
+    - name: type_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: type_id
+            description: Filter products by their type ID.
+          - type: array
+            description: Filter products by multiple type IDs.
+            items:
+              type: string
+              title: type_id
+              description: The type ID's details.
+    - name: deleted_at
+      in: query
+      description: Filter by a product's deletion date.
+      required: false
+      schema:
+        type: object
+        description: Filter by a product's deletion date.
+        properties:
+          $and:
+            type: array
+            description: >-
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
+            items:
+              type: string
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
+    - name: order
+      in: query
+      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 `-`.
+      required: false
+      schema:
+        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 `-`.
+        externalDocs:
+          url: '#pagination'
+    - name: q
+      in: query
+      description: The product's q.
+      required: false
+      schema:
+        type: string
+        title: q
+        description: The product's q.
+    - name: category_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: category_id
+            description: Filter products by their category ID.
+          - type: array
+            description: Filter products by their category IDs.
+            items:
+              type: string
+              title: category_id
+              description: A category ID.
+    - name: limit
+      in: query
+      description: Limit the number of items returned in the list.
+      required: false
+      schema:
+        type: number
+        title: limit
+        description: Limit the number of items returned in the list.
+        externalDocs:
+          url: '#pagination'
+    - name: offset
+      in: query
+      description: The number of items to skip when retrieving a list.
+      required: false
+      schema:
+        type: number
+        title: offset
+        description: The number of items to skip when retrieving a list.
+        externalDocs:
+          url: '#pagination'
+    - name: with_deleted
+      in: query
+      description: The product's with deleted.
+      required: false
+      schema:
+        type: boolean
+        title: with_deleted
+        description: The product's with deleted.
+    - name: $and
+      in: query
+      description: >-
+        Join query parameters with an AND condition. Each object's content is
+        the same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an AND condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $and
+    - name: $or
+      in: query
+      description: >-
+        Join query parameters with an OR condition. Each object's content is the
+        same type as the expected query parameters.
+      required: false
+      schema:
+        type: array
+        description: >-
+          Join query parameters with an OR condition. Each object's content is
+          the same type as the expected query parameters.
+        items:
+          type: object
+        title: $or
+    - name: price_list_id
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: price_list_id
+            description: Filter products by the ID of a price list they belong to.
+          - type: array
+            description: Filter products by the IDs of price lists they belong to.
+            items:
+              type: string
+              title: price_list_id
+              description: A price list ID.
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_products_{id}_images_{image_id}_variants_batch.yaml

@@ -0,0 +1,64 @@
+post:
+  operationId: PostProductsIdImagesImage_idVariantsBatch
+  summary: Manage Variants of Product Image
+  description: >-
+    Manage the association between product variants and a product image. You can
+    add or remove associations between variants and the image.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The product's ID.
+      required: true
+      schema:
+        type: string
+    - name: image_id
+      in: path
+      description: The product image's ID.
+      required: true
+      schema:
+        type: string
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/AdminBatchImageVariantRequest.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS SDK
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh
+  tags:
+    - Products
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminBatchImageVariantResponse.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: batchImageVariantsWorkflow
+  x-events: []
+  x-since: 2.11.2

www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml

@@ -37,8 +37,8 @@ post:
                   inventory item.
                 required:
                   - variant_id
-                  - inventory_item_id
                   - required_quantity
+                  - inventory_item_id
                 properties:
                   required_quantity:
                     type: number
@@ -71,8 +71,8 @@ post:
                 description: Update a product variant's association with an inventory item.
                 required:
                   - variant_id
-                  - inventory_item_id
                   - required_quantity
+                  - inventory_item_id
                 properties:
                   required_quantity:
                     type: number

www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_images_batch.yaml

@@ -0,0 +1,64 @@
+post:
+  operationId: PostProductsIdVariantsVariant_idImagesBatch
+  summary: Manage Images of Product Variant
+  description: >-
+    Manage the association between product images and a product variant. You can
+    add or remove associations between images and the variant.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The product's ID.
+      required: true
+      schema:
+        type: string
+    - name: variant_id
+      in: path
+      description: The product variant's ID.
+      required: true
+      schema:
+        type: string
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/AdminBatchVariantImagesRequest.yaml
+  x-codeSamples:
+    - lang: JavaScript
+      label: JS SDK
+      source:
+        $ref: >-
+          ../code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: >-
+          ../code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh
+  tags:
+    - Products
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminBatchVariantImagesResponse.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: batchVariantImagesWorkflow
+  x-events: []
+  x-since: 2.11.2

www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml

@@ -60,28 +60,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: promotion_type
-      in: query
-      description: The promotion type to retrieve rules for.
-      required: false
-      schema:
-        type: string
-        title: promotion_type
-        description: The promotion type to retrieve rules for.
-        enum:
-          - standard
-          - buyget
-    - name: application_method_type
-      in: query
-      description: The application method type to retrieve rules for.
-      required: false
-      schema:
-        type: string
-        title: application_method_type
-        description: The application method type to retrieve rules for.
-        enum:
-          - fixed
-          - percentage
     - name: with_deleted
       in: query
       description: Whether to include deleted records in the result.
@@ -96,8 +74,47 @@ get:
       required: false
       schema:
         type: string
-        title: application_method_target_type
         description: The application method target type to retrieve rules for.
+    - name: q
+      in: query
+      description: Apply a search query on the rule values' searchable properties.
+      required: false
+      schema:
+        type: string
+        title: q
+        description: Apply a search query on the rule values' searchable properties.
+    - name: value
+      in: query
+      required: false
+      schema:
+        oneOf:
+          - type: string
+            title: value
+            description: Filter by a specific rule value.
+          - type: array
+            description: Filter by multiple rule values.
+            items:
+              type: string
+              title: value
+              description: A rule value.
+    - 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: []

www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml

@@ -13,24 +13,37 @@ post:
       required: true
       schema:
         type: string
-    - name: fields
+    - name: promotion_type
       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.
+      description: The promotion's type.
       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'
+        description: The promotion's type.
+        enum:
+          - standard
+          - buyget
+    - name: application_method_type
+      in: query
+      description: The promotion's application method type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method type.
+        enum:
+          - fixed
+          - percentage
+    - name: application_method_target_type
+      in: query
+      description: The promotion's application method target type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method target type.
+        enum:
+          - items
+          - shipping_methods
+          - order
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml

@@ -11,24 +11,37 @@ post:
       required: true
       schema:
         type: string
-    - name: fields
+    - name: promotion_type
       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.
+      description: The promotion's type.
       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'
+        description: The promotion's type.
+        enum:
+          - standard
+          - buyget
+    - name: application_method_type
+      in: query
+      description: The promotion's application method type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method type.
+        enum:
+          - fixed
+          - percentage
+    - name: application_method_target_type
+      in: query
+      description: The promotion's application method target type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method target type.
+        enum:
+          - items
+          - shipping_methods
+          - order
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml

@@ -11,24 +11,37 @@ post:
       required: true
       schema:
         type: string
-    - name: fields
+    - name: promotion_type
       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.
+      description: The promotion's type.
       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'
+        description: The promotion's type.
+        enum:
+          - standard
+          - buyget
+    - name: application_method_type
+      in: query
+      description: The promotion's application method type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method type.
+        enum:
+          - fixed
+          - percentage
+    - name: application_method_target_type
+      in: query
+      description: The promotion's application method target type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method target type.
+        enum:
+          - items
+          - shipping_methods
+          - order
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml

@@ -49,6 +49,37 @@ get:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
+    - name: promotion_type
+      in: query
+      description: The type
+      required: false
+      schema:
+        type: string
+        description: The promotion's type.
+        enum:
+          - standard
+          - buyget
+    - name: application_method_type
+      in: query
+      description: The promotion's application method type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method type.
+        enum:
+          - fixed
+          - percentage
+    - name: application_method_target_type
+      in: query
+      description: The promotion's application method target type.
+      required: false
+      schema:
+        type: string
+        description: The promotion's application method target type.
+        enum:
+          - items
+          - shipping_methods
+          - order
   security:
     - api_token: []
     - cookie_auth: []

www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml

@@ -102,7 +102,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminUpdatePaymentRefundReason.yaml
+          $ref: ../components/schemas/AdminUpdateRefundReason.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

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

@@ -614,22 +614,153 @@ get:
         type: boolean
         title: with_deleted
         description: Whether to include deleted records in the result.
-    - name: order_id
+    - name: q
       in: query
+      description: Apply a search query on the reservation's searchable properties.
       required: false
       schema:
-        oneOf:
-          - type: string
-            title: order_id
-            description: Filter by an order's ID to retrieve its associated reservations.
-          - type: array
+        type: string
+        title: q
+        description: Apply a search query on the reservation's searchable properties.
+    - name: quantity
+      in: query
+      description: Filter by the reservation's quantity.
+      required: false
+      schema:
+        type: object
+        description: Filter by a reservation's quantity.
+        properties:
+          $and:
+            type: array
             description: >-
-              Filter by multiple order IDs to retrieve their associated
-              reservations.
+              Join query parameters with an AND condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $and
+          $or:
+            type: array
+            description: >-
+              Join query parameters with an OR condition. Each object's content
+              is the same type as the expected query parameters.
+            items:
+              type: object
+            title: $or
+          $eq:
+            oneOf:
+              - type: string
+                title: $eq
+                description: Filter by an exact match.
+              - type: array
+                description: Filter by an exact match.
+                items:
+                  type: string
+                  title: $eq
+                  description: Filter by an exact match.
+          $ne:
+            type: string
+            title: $ne
+            description: Filter by values not equal to this parameter.
+          $in:
+            type: array
+            description: Filter by values in this array.
             items:
               type: string
-              title: order_id
-              description: An order's ID.
+              title: $in
+              description: Filter by values in this array.
+          $nin:
+            type: array
+            description: Filter by values not in this array.
+            items:
+              type: string
+              title: $nin
+              description: Filter by values not in this array.
+          $not:
+            oneOf:
+              - type: string
+                title: $not
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: object
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+              - type: array
+                description: >-
+                  Filter by values not matching the conditions in this
+                  parameter.
+                items:
+                  type: string
+                  title: $not
+                  description: >-
+                    Filter by values not matching the conditions in this
+                    parameter.
+          $gt:
+            type: string
+            title: $gt
+            description: >-
+              Filter by values greater than this parameter. Useful for numbers
+              and dates only.
+          $gte:
+            type: string
+            title: $gte
+            description: >-
+              Filter by values greater than or equal to this parameter. Useful
+              for numbers and dates only.
+          $lt:
+            type: string
+            title: $lt
+            description: >-
+              Filter by values less than this parameter. Useful for numbers and
+              dates only.
+          $lte:
+            type: string
+            title: $lte
+            description: >-
+              Filter by values less than or equal to this parameter. Useful for
+              numbers and dates only.
+          $like:
+            type: string
+            title: $like
+            description: Apply a `like` filter. Useful for strings only.
+          $re:
+            type: string
+            title: $re
+            description: Apply a regex filter. Useful for strings only.
+          $ilike:
+            type: string
+            title: $ilike
+            description: Apply a case-insensitive `like` filter. Useful for strings only.
+          $fulltext:
+            type: string
+            title: $fulltext
+            description: Filter to apply on full-text properties.
+          $overlap:
+            type: array
+            description: Filter arrays that have overlapping values with this parameter.
+            items:
+              type: string
+              title: $overlap
+              description: Filter arrays that have overlapping values with this parameter.
+          $contains:
+            type: array
+            description: Filter arrays that contain some of the values of this parameter.
+            items:
+              type: string
+              title: $contains
+              description: Filter arrays that contain some of the values of this parameter.
+          $contained:
+            type: array
+            description: Filter arrays that contain all values of this parameter.
+            items:
+              type: string
+              title: $contained
+              description: Filter arrays that contain all values of this parameter.
+          $exists:
+            type: boolean
+            title: $exists
+            description: Filter by whether a value for this parameter exists (not `null`).
   security:
     - api_token: []
     - cookie_auth: []

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

@@ -804,7 +804,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsReqSchema.yaml
+          $ref: ../components/schemas/AdminInitiateReturnRequest.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml

@@ -102,7 +102,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsReturnReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateReturnRequest.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminDismissItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsReceiveItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminReceiveItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml

@@ -38,7 +38,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReceiveReturnsReqSchema.yaml
+          $ref: ../components/schemas/AdminInitiateReceiveReturn.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml

@@ -38,7 +38,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml
+          $ref: ../components/schemas/AdminConfirmReceiveReturn.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsRequestItemsReqSchema.yaml
+          $ref: ../components/schemas/AdminAddReturnItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml

@@ -50,8 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: >-
-            ../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateReturnItems.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsConfirmRequestReqSchema.yaml
+          $ref: ../components/schemas/AdminConfirmReturnRequest.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method.yaml

@@ -39,7 +39,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsShippingReqSchema.yaml
+          $ref: ../components/schemas/AdminAddReturnShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_returns_{id}_shipping-method_{action_id}.yaml

@@ -50,7 +50,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminPostReturnsShippingActionReqSchema.yaml
+          $ref: ../components/schemas/AdminUpdateReturnShipping.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml

@@ -37,23 +37,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The products to add or remove from the channel.
-          properties:
-            add:
-              type: array
-              description: The products to add to the sales channel.
-              items:
-                type: string
-                title: add
-                description: A product's ID.
-            remove:
-              type: array
-              description: The products to remove from the sales channel.
-              items:
-                type: string
-                title: remove
-                description: A product's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml

@@ -104,7 +104,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../components/schemas/AdminUpdateShippingOptionType.yaml
+          $ref: ../components/schemas/AdminUpdateShippingOption.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml

@@ -39,23 +39,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The fulfillment providers to add or remove from the stock location.
-          properties:
-            add:
-              type: array
-              description: The fulfillment providers to add to the stock location.
-              items:
-                type: string
-                title: add
-                description: A fulfillment provider's ID.
-            remove:
-              type: array
-              description: The fulfillment providers to remove from the stock location.
-              items:
-                type: string
-                title: remove
-                description: A fulfillment provider's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml

@@ -37,23 +37,7 @@ post:
     content:
       application/json:
         schema:
-          type: object
-          description: The sales channels to add or remove.
-          properties:
-            add:
-              type: array
-              description: The sales channels to add.
-              items:
-                type: string
-                title: add
-                description: A sales channel's ID.
-            remove:
-              type: array
-              description: The sales channels to remove.
-              items:
-                type: string
-                title: remove
-                description: A sales channel's ID.
+          $ref: ../components/schemas/AdminBatchLink.yaml
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK

www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml

@@ -30,36 +30,6 @@ get:
           prefix it will replace the entire default fields.
         externalDocs:
           url: '#select-fields-and-relations'
-    - name: province_code
-      in: query
-      description: Filter by a tax region's province code.
-      required: false
-      schema:
-        type: string
-        title: province_code
-        description: Filter by a tax region's province code.
-    - name: provider_id
-      in: query
-      description: Filter by a tax provider ID to retrieve the tax regions using it.
-      required: false
-      schema:
-        type: string
-        title: provider_id
-        description: Filter by a tax provider ID to retrieve the tax regions using it.
-    - name: metadata
-      in: query
-      description: >-
-        Filter by a tax region's metadata. Refer to the [Object Query
-        Parameter](https://docs.medusajs.com/api/admin#object) section to learn
-        how to filter by object fields.
-      required: false
-      schema:
-        type: object
-        description: >-
-          Filter by a tax region's metadata. Refer to the [Object Query
-          Parameter](https://docs.medusajs.com/api/admin#object) section to
-          learn how to filter by object fields.
-        title: metadata
   security:
     - api_token: []
     - cookie_auth: []