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

openapi: 3.0.0
info:
  version: 2.0.0
  title: Medusa Storefront API
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/master/LICENSE
servers:
  - url: http://localhost:9000
  - url: https://api.medusajs.com
tags:
  - name: Auth
    description: |
      Auth API routes allow you to manage a customer's authentication.
  - name: Carts
    description: |
      A cart is a virtual shopping bag that customers can use to add items they want to purchase.

      A cart is then used to checkout and place an order.

      These API routes allow customers to create and manage their cart, and place an order.
    externalDocs:
      description: How to implement cart functionality in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/cart
    x-associatedSchema:
      $ref: '#/components/schemas/StoreCart'
  - name: Collections
    description: |
      A product collection organizes products into a collection for marketing purposes. For example, a summer collection.

      These API routes allow customers to browse collections and their products.
    externalDocs:
      description: How to list product collections in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
    x-associatedSchema:
      $ref: '#/components/schemas/StoreCollection'
  - name: Currencies
    description: |
      A store has multiple currencies, and product prices can be different for each currency.

      When retrieving product variant prices, you specify either the ID of a region or a currency that the customer selected.

      These API routes allow customers to browse currencies.
    externalDocs:
      description: How to retrieve product variant prices in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
    x-associatedSchema:
      $ref: '#/components/schemas/StoreCurrency'
  - name: Customers
    description: |
      Customers can place orders as guest customers or register.

      When a customer registers, they can manage their profile, save addresses for later usage, and more.

      These API routes allow customers to create and manage their accounts.
    externalDocs:
      description: How to implement customer account functionalities in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/customers
    x-associatedSchema:
      $ref: '#/components/schemas/StoreCustomer'
  - name: Orders
    description: |
      Guest and registered customers can view orders they placed.

      These API routes allow customers to view their orders.
    x-associatedSchema:
      $ref: '#/components/schemas/StoreOrder'
  - name: Payment Collections
    description: |
      A cart must have a payment collection with an authorized payment session.

      Use these API routes during checkout to set the cart's payment provider and authorize its payment session.
    externalDocs:
      description: How to implement payment during checkout.
      url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
    x-associatedSchema:
      $ref: '#/components/schemas/StorePaymentCollection'
  - name: Payment Providers
    description: |
      Each region has a set of payment providers enabled.

      During checkout, you retrieve the available payment providers in the customer's region to show them to the customer. Customers then choose their preferred provider to authorize their payment and place their order.

      These API routes allow customers to view available payment providers in their region.
    externalDocs:
      description: How to implement payment during checkout.
      url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
    x-associatedSchema:
      $ref: '#/components/schemas/StorePaymentProvider'
  - name: Product Categories
    description: |
      Products can be categorized into categories.

      These API routes allow customers to browse categories and their products.
    externalDocs:
      description: How to list product categories in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
    x-associatedSchema:
      $ref: '#/components/schemas/StoreProductCategory'
  - name: Products
    description: |
      Customers browse products for their purchase.

      A product has variants for different option values. The customer chooses from these variants before adding it to the cart.

      These API routes allow customers to browse products.
    externalDocs:
      description: How to list products, get their prices, and more in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/products
    x-associatedSchema:
      $ref: '#/components/schemas/StoreProduct'
  - name: Regions
    description: |
      Regions are different countries or geographical regions that the commerce store serves customers in.

      Customers can choose what region they're in to view prices of that region's currency.

      Use these API routes to retrieve available regions in the store.
    externalDocs:
      description: How to retrieve and store selected region in a storefront.
      url: https://docs.medusajs.com/v2/resources/storefront-development/regions
    x-associatedSchema:
      $ref: '#/components/schemas/StoreRegion'
  - name: Return
    description: |
      Customers can request to return items in their order. The admin user then receives and handles the return.

      These API routes allows customers to create a return.
    x-associatedSchema:
      $ref: '#/components/schemas/StoreReturn'
  - name: Return Reasons
    description: |
      A return reason is a possible reason a customer wants to return an item.

      Use these API routes when implementing return creation flow in your storefront to allow customers to select their return reason.
    x-associatedSchema:
      $ref: '#/components/schemas/StoreReturnReason'
  - name: Shipping Options
    description: |
      A shipping option is a way of shipping an item to or from the customer.

      During the checkout flow, the customer selects their preferred shipping option to receive their order.

      These API routes allow customers to retrieve available shipping options for their context.
    externalDocs:
      description: How to implement shipping during checkout.
      url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
    x-associatedSchema:
      $ref: '#/components/schemas/StoreShippingOption'
paths:
  /auth/customer/{auth_provider}:
    post:
      operationId: PostActor_typeAuth_provider
      summary: Authenticate Customer
      description: |
        Authenticate a customer and receive the JWT token to be used in the header of subsequent requests.

        When used with a third-party provider, such as Google, the request returns a `location` property. You redirect to the specified URL in your storefront to continue authentication with the third-party service.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#types-of-authentication-flows
        description: Learn about different authentication flows.
      x-authenticated: false
      parameters:
        - name: auth_provider
          in: path
          description: The provider used for authentication.
          required: true
          schema:
            type: string
            example: emailpass
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: input
              description: The input data necessary for authentication. For example, for email-pass authentication, pass `email` and `password` properties.
      x-codeSamples:
        - lang: Shell
          label: EmailPass Provider
          source: |-
            curl -X POST '{backend_url}/auth/customer/emailpass' \
            -H 'Content-Type: application/json' \
            --data-raw '{
              "email": "customer@gmail.com",
              "password": "supersecret"
            }'
        - lang: Shell
          label: Google Provider
          source: curl -X POST '{backend_url}/auth/customer/google'
        - lang: Shell
          label: GitHub Provider
          source: curl -X POST '{backend_url}/auth/customer/github'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AuthResponse'
                  - $ref: '#/components/schemas/AuthCallbackResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /auth/customer/{auth_provider}/callback:
    post:
      operationId: PostActor_typeAuth_providerCallback
      summary: Validate Authentication Callback
      description: |
        This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. 

        It validates the authentication with the third-party provider and, if successful, returns an authentication token.

        You can decode the JWT token using libraries like [react-jwt](https://www.npmjs.com/package/react-jwt) in the storefront. If the decoded data doesn't  have an `actor_id` property, then you must register the customer using the Create Customer API route passing the token in the request's Authorization header.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
        description: Learn about third-party authentication flow.
      x-authenticated: false
      parameters:
        - name: auth_provider
          in: path
          description: The provider used for authentication.
          required: true
          schema:
            type: string
            example: google
      x-codeSamples:
        - lang: Shell
          label: Google Provider
          source: curl -X POST '{backend_url}/auth/customer/google/callback?code=123'
        - lang: Shell
          label: GitHub Provider
          source: curl -X POST '{backend_url}/auth/customer/github/callback?code=123'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /auth/customer/{auth_provider}/register:
    post:
      operationId: PostActor_typeAuth_provider_register
      summary: Retrieve Registration JWT Token
      description: This API route retrieves a registration JWT token of a customer that hasn't been registered yet. The token is used in the header of requests that create a customer.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#1-basic-authentication-flow
        description: Learn about the basic authentication flow.
      x-authenticated: false
      parameters:
        - name: auth_provider
          in: path
          description: The provider used for authentication.
          required: true
          schema:
            type: string
            example: emailpass
      requestBody:
        content:
          application/json:
            schema:
              type: object
              title: input
              description: The input data necessary for authentication. For example, for email-pass authentication, pass `email` and `password` properties.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/auth/customer/emailpass/register' \
            -H 'Content-Type: application/json' \
            --data-raw '{
              "email": "customer@gmail.com",
              "password": "supersecret"
            }'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /auth/session:
    post:
      operationId: PostSession
      summary: Set Authentication Session
      description: Set the cookie session ID of a customer. The customer must be previously authenticated with the `/auth/customer/{provider}` API route first, as the JWT token is required in the header of the request.
      x-authenticated: true
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/auth/session' \
            -H 'Authorization: Bearer {jwt_token}'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthStoreSessionResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    delete:
      operationId: DeleteSession
      summary: Delete Authentication Session
      description: Deletes the cookie session ID previously set for authentication.
      x-authenticated: true
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X DELETE '{backend_url}/auth/session' \
            -H 'Cookie: connect.sid={sid}'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: SUMMARY
                required:
                  - success
                properties:
                  success:
                    type: boolean
                    title: success
                    description: Whether the session was deleted successfully.
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /auth/token/refresh:
    post:
      operationId: PostAdminAuthTokenRefresh
      summary: Refresh Authentication Token
      description: Refresh the authentication token of a customer. This is useful after authenticating a customer with a third-party service to ensure the token holds the new user's details, or when you don't want customers to re-login every day.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow
        description: Learn about third-party authentication flow.
      x-authenticated: true
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/auth/token/refresh' \
            -H 'Authorization: Bearer {token}'
      tags:
        - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/carts:
    post:
      operationId: PostCarts
      summary: Create Cart
      description: Create a cart.
      x-authenticated: false
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/StoreCreateCart'
                - type: object
                  description: The cart's details.
                  properties:
                    additional_data:
                      type: object
                      description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
              description: The cart's details.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createCartWorkflow
  /store/carts/{id}:
    get:
      operationId: GetCartsId
      summary: Get a Cart
      description: Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/carts/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    post:
      operationId: PostCartsId
      summary: Update a Cart
      description: Update a cart's details. This unsets the shipping an payment methods chosen before, and the customer would have to choose them again.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/UpdateCartData'
                - type: object
                  description: The properties to update in the cart item.
                  properties:
                    additional_data:
                      type: object
                      description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
              description: The properties to update in the cart item.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: The updated cart's details.
                required:
                  - cart
                properties:
                  cart:
                    $ref: '#/components/schemas/StoreCart'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateCartWorkflow
  /store/carts/{id}/complete:
    post:
      operationId: PostCartsIdComplete
      summary: Complete Cart
      description: Complete a cart and place an order.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/complete-cart
        description: 'Storefront guide: How to implement cart completion during checkout.'
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/complete' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    description: The created order's details.
                    required:
                      - type
                      - order
                    properties:
                      type:
                        type: string
                        title: type
                        description: The type of the returned object.
                        default: order
                      order:
                        $ref: '#/components/schemas/StoreOrder'
                  - type: object
                    description: The details of why the cart completion failed.
                    required:
                      - type
                      - cart
                      - error
                    properties:
                      type:
                        type: string
                        title: type
                        description: The type of the returned object.
                        default: cart
                      cart:
                        $ref: '#/components/schemas/StoreCart'
                      error:
                        type: object
                        description: The error's details.
                        required:
                          - message
                          - name
                          - type
                        properties:
                          message:
                            type: string
                            title: message
                            description: The error's message.
                          name:
                            type: string
                            title: name
                            description: The error's name.
                          type:
                            type: string
                            title: type
                            description: |
                              The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) or `payment_authorization_error` or `payment_requires_more_error` for payment-related errors.
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: completeCartWorkflow
  /store/carts/{id}/line-items:
    post:
      operationId: PostCartsIdLineItems
      summary: Add Line Item to Cart
      x-sidebar-summary: Add Line Item
      description: Add a product variant as a line item in the cart.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#add-product-variant-to-cart
        description: 'Storefront guide: How to add a product variant to the cart.'
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreAddCartLineItem'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/line-items' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "variant_id": "{value}",
              "quantity": 3360689747918848,
              "metadata": {}
            }'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: addToCartWorkflow
  /store/carts/{id}/line-items/{line_id}:
    post:
      operationId: PostCartsIdLineItemsLine_id
      summary: Update a Line Item in a Cart
      x-sidebar-summary: Update Line Item
      description: Update a line item's details in the cart.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#update-line-item-in-cart
        description: 'Storefront guide: How to update a cart''s line item.'
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: line_id
          in: path
          description: The line item's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreUpdateCartLineItem'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "quantity": 8980402259623936,
              "metadata": {}
            }'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateLineItemInCartWorkflow
    delete:
      operationId: DeleteCartsIdLineItemsLine_id
      summary: Remove Line Item from Cart
      x-sidebar-summary: Remove Line Item
      description: Remove a line item from a cart.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/cart/manage-items#remove-line-item-from-cart
        description: 'Storefront guide: How to remove line item from cart.'
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: line_id
          in: path
          description: The line item's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: The deletion's details.
                    required:
                      - id
                      - object
                      - deleted
                    properties:
                      id:
                        type: string
                        title: id
                        description: The ID of the deleted line item.
                      object:
                        type: string
                        title: object
                        description: The name of the deleted object.
                        default: line-item
                      deleted:
                        type: boolean
                        title: deleted
                        description: Whether the item was deleted.
                  - type: object
                    description: The deletion's details.
                    properties:
                      parent:
                        $ref: '#/components/schemas/StoreCart'
                        description: The cart that the item belonged to.
                description: The deletion's details.
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: deleteLineItemsWorkflow
  /store/carts/{id}/promotions:
    post:
      operationId: PostCartsIdPromotions
      summary: Add Promotions to Cart
      x-sidebar-summary: Add Promotions
      description: Add a list of promotions to a cart.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The promotion's details.
              required:
                - promo_codes
              properties:
                promo_codes:
                  type: array
                  description: Promotion codes to add to the cart.
                  items:
                    type: string
                    title: promo_codes
                    description: A promotion code.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/promotions' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "promo_codes": [
                "{value}"
              ]
            }'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateCartPromotionsWorkflow
    delete:
      operationId: DeleteCartsIdPromotions
      summary: Remove Promotions from Cart
      description: Remove a list of promotions from a cart.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X DELETE '{backend_url}/store/carts/{id}/promotions' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: The cart's details.
                required:
                  - cart
                properties:
                  cart:
                    $ref: '#/components/schemas/StoreCart'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateCartPromotionsWorkflow
  /store/carts/{id}/shipping-methods:
    post:
      operationId: PostCartsIdShippingMethods
      summary: Add Shipping Method to Cart
      x-sidebar-summary: Add Shipping Method
      description: Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
        description: 'Storefront guide: How to implement shipping during checkout.'
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The shipping method's details.
              required:
                - option_id
              properties:
                option_id:
                  type: string
                  title: option_id
                  description: The ID of the shipping option this method is created from.
                data:
                  type: object
                  description: Any additional data relevant for the third-party fulfillment provider to process the shipment.
                  externalDocs:
                    url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
                    description: Learn more about the `data` parameter.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "option_id": "{value}"
            }'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: addShippingMethodToWorkflow
  /store/carts/{id}/taxes:
    post:
      operationId: PostCartsIdTaxes
      summary: Calculate Cart Taxes
      x-sidebar-summary: Calculate Taxes
      description: Calculate the cart's tax lines and amounts.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The cart's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreCalculateCartTaxes'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/carts/{id}/taxes' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCartResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateTaxLinesWorkflow
  /store/collections:
    get:
      operationId: GetCollections
      summary: List Collections
      description: Retrieve a list of collections. The collections can be filtered by fields such as `handle`. The collections can also be sorted or paginated.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list
        description: 'Storefront guide: How to retrieve a list of collections.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: deleted_at
          in: query
          description: Filter by the collection's deletion date.
          required: false
          schema:
            type: object
            description: Filter by the collection'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.
                    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`).
                  - 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: title
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: title
                description: Filter by a collection's title.
              - type: array
                description: Filter by collection titles.
                items:
                  type: string
                  title: title
                  description: A title.
        - name: created_at
          in: query
          description: Filter by the collection's creation date.
          required: false
          schema:
            type: object
            description: Filter by the collection'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 collection's update date.
          required: false
          schema:
            type: object
            description: Filter by the collection'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: handle
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: handle
                description: Filter by a collection's handle.
              - type: array
                description: Filter by collection handles.
                items:
                  type: string
                  title: handle
                  description: A handle.
        - name: q
          in: query
          description: Search term to filter the collection's searchable properties.
          required: false
          schema:
            type: string
            title: q
            description: Search term to filter the collection's searchable properties.
        - 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
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/collections' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Collections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: SUMMARY
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The collection's limit.
                      offset:
                        type: number
                        title: offset
                        description: The collection's offset.
                      count:
                        type: number
                        title: count
                        description: The collection's count.
                  - type: object
                    description: SUMMARY
                    required:
                      - collections
                    properties:
                      collections:
                        type: array
                        description: The collection's collections.
                        items:
                          $ref: '#/components/schemas/StoreCollection'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/collections/{id}:
    get:
      operationId: GetCollectionsId
      summary: Get a Collection
      description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/retrieve
        description: 'Storefront guide: How to retrieve a collection.'
      parameters:
        - name: id
          in: path
          description: The collection's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/collections/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Collections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCollectionResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/currencies:
    get:
      operationId: GetCurrencies
      summary: List Currencies
      description: Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated.
      x-authenticated: false
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: q
          in: query
          description: Search term to filter the currency's searchable properties.
          required: false
          schema:
            type: string
            title: q
            description: Search term to filter the currency's searchable properties.
        - name: code
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: code
                description: Filter by a currency code.
              - type: array
                description: Filter by currency codes.
                items:
                  type: string
                  title: code
                  description: A currency code.
        - 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
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/currencies' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Currencies
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCurrencyListResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/currencies/{code}:
    get:
      operationId: GetCurrenciesCode
      summary: Get a Currency
      description: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned.
      x-authenticated: false
      parameters:
        - name: code
          in: path
          description: The currency's code.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/currencies/{code}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Currencies
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCurrencyResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/customers:
    post:
      operationId: PostCustomers
      summary: Register Customer
      description: Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register
        description: 'Storefront guide: How to register a customer.'
      x-authenticated: true
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreCreateCustomer'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/customers' \
            -H 'Authorization: Bearer {token}' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "email": "Monserrate.Leannon88@yahoo.com",
              "company_name": "{value}",
              "first_name": "{value}",
              "last_name": "{value}",
              "phone": "{value}"
            }'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createCustomerAccountWorkflow
  /store/customers/me:
    get:
      operationId: GetCustomersMe
      summary: Get Logged-in Customer
      x-sidebar-summary: Get Customer
      description: Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned.
      x-authenticated: true
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve
        description: 'Storefront guide: How to retrieve the logged-in customer.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/customers/me' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    post:
      operationId: PostCustomersMe
      summary: Update Customer
      description: Update the logged-in customer's details.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/profile
        description: 'Storefront guide: How to edit a customer''s profile.'
      x-authenticated: true
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreUpdateCustomer'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/customers/me' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "company_name": "{value}",
              "first_name": "{value}",
              "last_name": "{value}",
              "phone": "{value}"
            }'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateCustomersWorkflow
  /store/customers/me/addresses:
    get:
      operationId: GetCustomersMeAddresses
      summary: List Customer's Addresses
      x-sidebary-summary: List Addresses
      description: Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as `country_code`. The addresses can also be sorted or paginated.
      x-authenticated: true
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses
        description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: city
          in: query
          description: Filter by the address's city.
          required: true
          schema:
            type: string
            title: city
            description: Filter by the address's city.
        - name: postal_code
          in: query
          description: Filter by the address's postal code.
          required: true
          schema:
            type: string
            title: postal_code
            description: Filter by the address's postal code.
        - name: country_code
          in: query
          description: Filter by the address's country code.
          required: true
          schema:
            type: string
            title: country_code
            description: Filter by the address's country code.
        - name: q
          in: query
          description: Search term to filter the address's searchable properties.
          required: true
          schema:
            type: string
            title: q
            description: Search term to filter the address's searchable properties.
      security:
        - cookie_auth: []
        - jwt_token: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/customers/me/addresses' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerAddressListResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    post:
      operationId: PostCustomersMeAddresses
      summary: Create Address for Logged-In Customer
      x-sidebar-summary: Create Address
      description: Create an address for the logged-in customer.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#add-customer-address
        description: 'Storefront guide: How to create an address for the logged-in customer.'
      x-authenticated: true
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The address's details.
              properties:
                first_name:
                  type: string
                  title: first_name
                  description: The customer's first name.
                last_name:
                  type: string
                  title: last_name
                  description: The customer's last name.
                phone:
                  type: string
                  title: phone
                  description: The customer's phone.
                company:
                  type: string
                  title: company
                  description: The address's company.
                address_1:
                  type: string
                  title: address_1
                  description: The address's first line.
                address_2:
                  type: string
                  title: address_2
                  description: The address's second line.
                city:
                  type: string
                  title: city
                  description: The address's city.
                country_code:
                  type: string
                  title: country_code
                  description: The address's country code.
                province:
                  type: string
                  title: province
                  description: The address's province.
                postal_code:
                  type: string
                  title: postal_code
                  description: The address's postal code.
                address_name:
                  type: string
                  title: address_name
                  description: The address's name.
                is_default_shipping:
                  type: boolean
                  title: is_default_shipping
                  description: Whether the address is used by default for shipping during checkout.
                is_default_billing:
                  type: boolean
                  title: is_default_billing
                  description: Whether the address is used by default for billing during checkout.
                metadata:
                  type: object
                  description: Holds custom key-value pairs.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/customers/me/addresses' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "metadata": {},
              "first_name": "{value}",
              "last_name": "{value}",
              "phone": "{value}",
              "company": "{value}",
              "address_1": "{value}",
              "address_2": "{value}",
              "city": "{value}",
              "country_code": "{value}",
              "province": "{value}",
              "postal_code": "{value}",
              "address_name": "{value}"
            }'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createCustomerAddressesWorkflow
  /store/customers/me/addresses/{address_id}:
    get:
      operationId: GetCustomersMeAddressesAddress_id
      summary: Get Customer's Address
      x-sidebar-summary: Get Address
      description: Retrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned.
      x-authenticated: true
      parameters:
        - name: address_id
          in: path
          description: The address's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/customers/me/addresses/{address_id}' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerAddressResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    post:
      operationId: PostCustomersMeAddressesAddress_id
      summary: Update Customer's Address
      x-sidebar-summary: Update Address
      description: Update the logged-in customer's address.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#edit-an-address
        description: 'Storefront guide: How to update an address of the logged-in customer.'
      x-authenticated: true
      parameters:
        - name: address_id
          in: path
          description: The address's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The properties to update in the address.
              properties:
                first_name:
                  type: string
                  title: first_name
                  description: The customer's first name.
                last_name:
                  type: string
                  title: last_name
                  description: The customer's last name.
                phone:
                  type: string
                  title: phone
                  description: The customer's phone.
                company:
                  type: string
                  title: company
                  description: The address's company.
                address_1:
                  type: string
                  title: address_1
                  description: The address's first line.
                address_2:
                  type: string
                  title: address_2
                  description: The address's second line.
                city:
                  type: string
                  title: city
                  description: The address's city.
                country_code:
                  type: string
                  title: country_code
                  description: The address's country code.
                province:
                  type: string
                  title: province
                  description: The address's province.
                postal_code:
                  type: string
                  title: postal_code
                  description: The address's postal code.
                address_name:
                  type: string
                  title: address_name
                  description: The address's name.
                is_default_shipping:
                  type: boolean
                  title: is_default_shipping
                  description: Whether the address is used by default for shipping during checkout.
                is_default_billing:
                  type: boolean
                  title: is_default_billing
                  description: Whether the address is used by default for billing during checkout.
                metadata:
                  type: object
                  description: Holds custom key-value pairs.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
            -H 'Authorization: Bearer {access_token}' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "first_name": "{value}",
            }'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCustomerResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: updateCustomerAddressesWorkflow
    delete:
      operationId: DeleteCustomersMeAddressesAddress_id
      summary: Remove Customer's Address
      x-sidebar-summary: Remove Address
      description: Remove an address of the logged-in customer.
      x-authenticated: true
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#delete-customer-address
        description: 'Storefront guide: How to delete a customer''s address.'
      parameters:
        - name: address_id
          in: path
          description: The address's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      security:
        - cookie_auth: []
        - jwt_token: []
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            -H 'Authorization: Bearer {access_token}'
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: The deletion's details.
                    required:
                      - id
                      - object
                      - deleted
                    properties:
                      id:
                        type: string
                        title: id
                        description: The address's ID.
                      object:
                        type: string
                        title: object
                        description: The name of the deleted object.
                        default: address
                      deleted:
                        type: boolean
                        title: deleted
                        description: Whether the address was deleted.
                  - type: object
                    description: The deletion's details.
                    properties:
                      parent:
                        $ref: '#/components/schemas/StoreCustomer'
                        description: The details of the customer the address belongs to.
                description: The deletion's details.
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: deleteCustomerAddressesWorkflow
  /store/orders:
    get:
      operationId: GetOrders
      summary: List Logged-in Customer's Orders
      x-sidebar-summary: List Orders
      description: Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated.
      x-authenticated: true
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: id
                description: Filter by an order ID.
              - type: array
                description: Filter by order IDs.
                items:
                  type: string
                  title: id
                  description: An order ID.
        - name: $and
          in: query
          required: false
          schema:
            type: array
            description: The order's $and.
            items:
              type: object
            title: $and
        - name: $or
          in: query
          required: false
          schema:
            type: array
            description: The order's $or.
            items:
              type: object
            title: $or
        - name: status
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: status
                description: The order's status.
              - type: string
                title: status
                description: The order's status.
              - type: string
                title: status
                description: The order's status.
              - type: string
                title: status
                description: The order's status.
              - type: string
                title: status
                description: The order's status.
              - type: string
                title: status
                description: The order's status.
              - type: array
                description: The order's status.
                items:
                  type: string
                  description: The status's details.
                  enum:
                    - canceled
                    - requires_action
                    - pending
                    - completed
                    - draft
                    - archived
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/orders' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Orders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: SUMMARY
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The order's limit.
                      offset:
                        type: number
                        title: offset
                        description: The order's offset.
                      count:
                        type: number
                        title: count
                        description: The order's count.
                  - type: object
                    description: SUMMARY
                    required:
                      - orders
                    properties:
                      orders:
                        type: array
                        description: The order's orders.
                        items:
                          $ref: '#/components/schemas/StoreOrder'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      security:
        - cookie_auth: []
        - jwt_token: []
  /store/orders/{id}:
    get:
      operationId: GetOrdersId
      summary: Get an Order
      description: Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The order's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/orders/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Orders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreOrderResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/payment-collections:
    post:
      operationId: PostPaymentCollections
      summary: Create Payment Collection
      description: Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
        description: 'Storefront guide: How to implement payment during checkout.'
      x-authenticated: false
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreCreatePaymentCollection'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/payment-collections' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "cart_id": "{value}",
              "region_id": "{value}",
              "currency_code": "{value}",
              "amount": 8468325826822144
            }'
      tags:
        - Payment Collections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorePaymentCollectionResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createPaymentCollectionForCartWorkflow
  /store/payment-collections/{id}/payment-sessions:
    post:
      operationId: PostPaymentCollectionsIdPaymentSessions
      summary: Initialize Payment Session of a Payment Collection
      x-sidebar-summary: Initialize Payment Session
      description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
        description: 'Storefront guide: How to implement payment during checkout.'
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The payment collection's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: The payment session's details.
              required:
                - provider_id
              properties:
                provider_id:
                  type: string
                  title: provider_id
                  description: The ID of the payment provider the customer chose.
                  example: pp_stripe_stripe
                context:
                  type: object
                  description: The payment's context, such as the customer or address details. If the customer is logged-in, the customer `id` is set in the context under a `customer.id` property.
                data:
                  type: object
                  description: Any data necessary for the payment provider to process the payment.
                  externalDocs:
                    url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
                    description: Learn more about the payment session's data property
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "provider_id": "{value}"
            }'
      tags:
        - Payment Collections
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorePaymentCollectionResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createPaymentSessionsWorkflow
  /store/payment-providers:
    get:
      operationId: GetPaymentProviders
      summary: List Payment Providers
      description: Retrieve a list of payment providers. You must provide the `region_id` query parameter to retrieve the payment providers enabled in that region.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment
        description: 'Storefront guide: How to implement payment during checkout.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: region_id
          in: query
          description: Filter by a region ID to get the payment providers enabled in that region.
          required: true
          schema:
            type: string
            title: region_id
            description: Filter by a region ID.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/payment-providers' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Payment Providers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: The list of payment providers.
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The maximum number of items returned.
                      offset:
                        type: number
                        title: offset
                        description: The number of items skipped before retrieving the returned items.
                      count:
                        type: number
                        title: count
                        description: The total number of items.
                  - type: object
                    description: The list of payment providers.
                    required:
                      - payment_providers
                    properties:
                      payment_providers:
                        type: array
                        description: The list of payment providers.
                        items:
                          $ref: '#/components/schemas/StorePaymentProvider'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/product-categories:
    get:
      operationId: GetProductCategories
      summary: List Product Categories
      description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
        description: 'Storefront guide: How to retrieve a list of product categories.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: q
          in: query
          description: Search term to filter the product category's properties.
          required: false
          schema:
            type: string
            title: q
            description: Search term to filter the product category's properties.
        - name: id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: id
                description: Filter by a product category's ID.
              - type: array
                description: Filter by product category IDs.
                items:
                  type: string
                  title: id
                  description: A product category ID.
        - name: description
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: description
                description: Filter by a description. This only matches categories with the exact description. To search by a term or keyword, use the `q` query parameter instead.
              - type: array
                description: Filter by descriptions. This only matches categories that have one of the provided descriptions. To search by a term or keyword, use the `q` query parameter instead.
                items:
                  type: string
                  title: description
                  description: A description.
        - name: handle
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: handle
                description: Filter by a category's handle.
              - type: array
                description: Filter by category handles.
                items:
                  type: string
                  title: handle
                  description: A handle.
        - name: parent_category_id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: parent_category_id
                description: The ID of a category to retrieve its child categories.
              - type: array
                description: The ID of categories to retrieve their child categories.
                items:
                  type: string
                  title: parent_category_id
                  description: A product category's ID.
        - name: include_ancestors_tree
          in: query
          description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
          required: false
          schema:
            type: boolean
            title: include_ancestors_tree
            description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
        - name: include_descendants_tree
          in: query
          description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
          required: false
          schema:
            type: boolean
            title: include_descendants_tree
            description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
        - name: created_at
          in: query
          description: Filter by the category's creation date.
          required: false
          schema:
            type: object
            description: Filter by the category'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 category's update date.
          required: false
          schema:
            type: object
            description: Filter by the category'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 category's deletion date.
          required: false
          schema:
            type: object
            description: Filter by the category'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: $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: The product category's $or.
            items:
              type: object
            title: $or
        - name: name
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: name
                description: Filter by a product category name.
              - type: array
                description: Filter by product category names.
                items:
                  type: string
                  title: name
                  description: A product category name.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/product-categories' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Product Categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreProductCategoryListResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/product-categories/{id}:
    get:
      operationId: GetProductCategoriesId
      summary: Get a Product Category
      description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/retrieve
        description: 'Storefront guide: How to retrieve a product category.'
      parameters:
        - name: id
          in: path
          description: The product category's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - name: include_ancestors_tree
          in: query
          description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
          required: false
          schema:
            type: boolean
            title: include_ancestors_tree
            description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
        - name: include_descendants_tree
          in: query
          description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
          required: false
          schema:
            type: boolean
            title: include_descendants_tree
            description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/product-categories/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Product Categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreProductCategoryResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/products:
    get:
      operationId: GetProducts
      summary: List Products
      description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
        description: 'Storefront guide: How to retrieve a product variants'' prices.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - 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: q
          in: query
          description: Search term to filter the product's searchable properties.
          required: false
          schema:
            type: string
            title: q
            description: Search term to filter the product's searchable properties.
        - name: id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: id
                description: Filter by a product ID.
              - type: array
                description: Filter by product IDs.
                items:
                  type: string
                  title: id
                  description: A product ID.
        - name: title
          in: query
          description: Filter by product titles.
          required: false
          schema:
            oneOf:
              - type: string
                title: title
                description: Filter by a title.
              - type: array
                description: Filter by titles.
                items:
                  type: string
                  title: title
                  description: A title.
        - name: handle
          in: query
          description: Filter by product handles.
          required: false
          schema:
            oneOf:
              - type: string
                title: handle
                description: Filter by a product handle.
              - type: array
                description: Filter by product handles.
                items:
                  type: string
                  title: handle
                  description: A product handle.
        - name: is_giftcard
          in: query
          description: Whether the product is a gift card.
          required: false
          schema:
            type: boolean
            title: is_giftcard
            description: Whether the product is a gift card.
        - name: collection_id
          in: query
          description: Filter by a collection's ID to retrieve the products in it.
          required: false
          schema:
            description: Filter by a collection's ID to retrieve the products in it.
            externalDocs:
              url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/products
              description: 'Storefront guide: Retrieve a collection''s products.'
            items:
              type: string
              title: collection_id
              description: A collection's ID.
        - name: tag_id
          in: query
          description: Filter by a tag's ID to retrieve the products in it.
          required: false
          schema:
            oneOf:
              - type: string
                title: tag_id
                description: Filter by a product tag's ID.
              - type: array
                description: Filter by product tag IDs.
                items:
                  type: string
                  title: tag_id
                  description: A product tag ID.
        - name: type_id
          in: query
          description: Filter by a type's ID to retrieve the products in it.
          required: false
          schema:
            oneOf:
              - type: string
                title: type_id
                description: Filter by a product type's ID.
              - type: array
                description: Filter by product type IDs.
                items:
                  type: string
                  title: type_id
                  description: A product type ID.
        - name: created_at
          in: query
          description: Filter by the product's creation date.
          required: false
          schema:
            type: object
            description: Filter by the 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 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 product's update date.
          required: false
          schema:
            type: object
            description: Filter by the 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 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 product's date date.
          required: false
          schema:
            type: object
            description: Filter by the product's date 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: region_id
          in: query
          description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
          required: false
          schema:
            type: string
            title: region_id
            description: The ID of the region the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
            externalDocs:
              url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
              description: 'Storefront guide: How to show product variants'' prices with taxes.'
        - name: country_code
          in: query
          description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
          required: false
          schema:
            type: string
            title: country_code
            description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes.
        - name: province
          in: query
          description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
          required: false
          schema:
            type: string
            title: province
            description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
        - name: cart_id
          in: query
          description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
          required: false
          schema:
            type: string
            title: cart_id
            description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
        - name: sales_channel_id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: sales_channel_id
                description: The ID of a sales channel to retrieve products in it.
              - type: array
                description: The IDs of sales channels to retrieve products in them.
                items:
                  type: string
                  title: sales_channel_id
                  description: A sales channel's ID.
        - name: category_id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: category_id
                description: The ID of a product category to retrieve products in it.
              - type: array
                description: The ID of product categories to retrieve products in them.
                items:
                  type: string
                  title: category_id
                  description: A product category's ID.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/products' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Products
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: The paginated list of products.
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The maximum number of items returned.
                      offset:
                        type: number
                        title: offset
                        description: The number of items skipped before retrieving the returned items.
                      count:
                        type: number
                        title: count
                        description: The total number of items.
                  - type: object
                    description: The paginated list of products.
                    required:
                      - products
                    properties:
                      products:
                        type: array
                        description: The list of products.
                        items:
                          type: object
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/products/{id}:
    get:
      operationId: GetProductsId
      summary: Get a Product
      description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/products/price
        description: 'Storefront guide: How to retrieve a product variants'' prices.'
      parameters:
        - name: id
          in: path
          description: The product's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - name: region_id
          in: query
          description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
          required: false
          schema:
            type: string
            title: region_id
            description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
            externalDocs:
              url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
              description: 'Storefront guide: How to show product variants'' prices with taxes.'
        - name: country_code
          in: query
          description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
          required: false
          schema:
            type: string
            title: country_code
            description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
        - name: province
          in: query
          description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
          required: false
          schema:
            type: string
            title: province
            description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
        - name: cart_id
          in: query
          description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
          required: false
          schema:
            type: string
            title: cart_id
            description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/products/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Products
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreProductResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/regions:
    get:
      operationId: GetRegions
      summary: List Regions
      description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.
      x-authenticated: false
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list
        description: 'Storefront guide: How to retrieve a list of regions.'
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: q
          in: query
          description: Search term to filter the region's searchable properties.
          required: false
          schema:
            type: string
            title: q
            description: Search term to filter the region's searchable properties.
        - name: id
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: id
                description: Filter by a region's ID.
              - type: array
                description: Filter by region IDs.
                items:
                  type: string
                  title: id
                  description: A region's ID.
        - name: name
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: name
                description: Filter by a region name.
              - type: array
                description: Filter by region names.
                items:
                  type: string
                  title: name
                  description: A region's name.
        - name: currency_code
          in: query
          required: false
          schema:
            oneOf:
              - type: string
                title: currency_code
                description: Filter by a currency code to retrieve regions that use that code.
              - type: array
                description: Filter by currency codes to retrieve regions that use one of these codes.
                items:
                  type: string
                  title: currency_code
                  description: A currency code.
        - 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
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/regions' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Regions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: SUMMARY
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The region's limit.
                      offset:
                        type: number
                        title: offset
                        description: The region's offset.
                      count:
                        type: number
                        title: count
                        description: The region's count.
                  - type: object
                    description: SUMMARY
                    required:
                      - regions
                    properties:
                      regions:
                        type: array
                        description: The region's regions.
                        items:
                          $ref: '#/components/schemas/StoreRegion'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/regions/{id}:
    get:
      operationId: GetRegionsId
      summary: Get a Region
      description: Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The region's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: curl '{backend_url}/store/regions/{id}'
      tags:
        - Regions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: SUMMARY
                required:
                  - region
                properties:
                  region:
                    $ref: '#/components/schemas/StoreRegion'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/return:
    post:
      operationId: PostReturn
      summary: Create Return
      description: Create a return for an order's items. The admin receives the return and process it from their side.
      x-authenticated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreCreateReturn'
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl -X POST '{backend_url}/store/return' \
            -H 'Content-Type: application/json' \ \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
            --data-raw '{
              "order_id": "{value}",
              "items": [
                {
                  "id": "id_XbfptxUVo2io9EI",
                  "quantity": 7916429753974784,
                  "reason_id": "{value}",
                  "note": "{value}"
                }
              ],
              "return_shipping": {
                "option_id": "{value}",
                "price": 1068364080349184
              },
              "note": "{value}",
              "location_id": "{value}"
            }'
      tags:
        - Return
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreReturnResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: createAndCompleteReturnOrderWorkflow
  /store/return-reasons:
    get:
      operationId: GetReturnReasons
      summary: List Return Reasons
      description: Retrieve a list of return reasons. The return reasons can be sorted or paginated.
      x-authenticated: false
      parameters:
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
        - 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.
        - 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.
        - 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 `-`.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/return-reasons' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Return Reasons
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    description: The paginated list of return reasons.
                    required:
                      - limit
                      - offset
                      - count
                    properties:
                      limit:
                        type: number
                        title: limit
                        description: The maximum number of items returned.
                      offset:
                        type: number
                        title: offset
                        description: The number of items skipped before retrieving the returned items.
                      count:
                        type: number
                        title: count
                        description: The total number of items.
                  - type: object
                    description: The paginated list of return reasons.
                    required:
                      - return_reasons
                    properties:
                      return_reasons:
                        type: array
                        description: The list of return reasons.
                        items:
                          $ref: '#/components/schemas/StoreReturnReason'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/return-reasons/{id}:
    get:
      operationId: GetReturnReasonsId
      summary: Get a Return Reason
      description: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.
      x-authenticated: false
      parameters:
        - name: id
          in: path
          description: The return reason's ID.
          required: true
          schema:
            type: string
        - name: expand
          in: query
          description: Comma-separated relations that should be expanded in the returned data.
          required: false
          schema:
            type: string
            title: expand
            description: Comma-separated relations that should be expanded in the returned data.
        - 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.
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/return-reasons/{id}' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Return Reasons
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreReturnReasonResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
  /store/shipping-options:
    get:
      operationId: GetShippingOptions
      summary: List Shipping Options for Cart
      description: |
        Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter.

        The shipping options also be sorted or paginated.
      externalDocs:
        url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping
        description: 'Storefront guide: How to implement shipping during checkout.'
      x-authenticated: false
      parameters:
        - 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.
        - 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.
        - 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.
        - 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 `-`.
        - name: cart_id
          in: query
          description: The ID of the cart to retrieve its shipping options.
          required: true
          schema:
            type: string
            title: cart_id
            description: The ID of the cart to retrieve its shipping options.
        - 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
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl '{backend_url}/store/shipping-options' \
            -H 'x-publishable-api-key: {your_publishable_api_key}'
      tags:
        - Shipping Options
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreShippingOptionListResponse'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
      x-workflow: listShippingOptionsForCartWorkflow
components:
  schemas:
    AdminApiKey:
      type: object
      description: The API key's details.
      x-schemaName: AdminApiKey
      required:
        - id
        - token
        - redacted
        - title
        - type
        - last_used_at
        - created_by
        - created_at
        - revoked_by
        - revoked_at
      properties:
        id:
          type: string
          title: id
          description: The api key's ID.
        token:
          type: string
          title: token
          description: The api key's token.
        redacted:
          type: string
          title: redacted
          description: The redacted form of the API key's token. This is useful when showing portion of the token.
          example: sk_...123
        title:
          type: string
          title: title
          description: The api key's title.
        type:
          type: string
          description: The api key's type. `secret` is used for a user's API key, whereas `publishable` is used for Publishable API keys.
          enum:
            - secret
            - publishable
        last_used_at:
          type: string
          title: last_used_at
          description: The date and time the API key was last used.
          format: date-time
        created_by:
          type: string
          title: created_by
          description: The ID of the user that created the API key, if available.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date and time the API key was created.
        revoked_by:
          type: string
          title: revoked_by
          description: The ID of the user that revoked the API key, if available.
        revoked_at:
          type: string
          title: revoked_at
          description: The date and time the API key was revoked. The API key is considered revoked when this property is set.
          format: date-time
    AdminApiKeyResponse:
      type: object
      description: The API key's details.
      x-schemaName: AdminApiKeyResponse
      required:
        - api_key
      properties:
        api_key:
          $ref: '#/components/schemas/AdminApiKey'
    AdminArchiveOrder:
      type: object
      description: SUMMARY
      x-schemaName: AdminArchiveOrder
      required:
        - order_id
      properties:
        order_id:
          type: string
          title: order_id
          description: The order's order id.
    AdminBatchProductRequest:
      type: object
      description: The products to create, update, or delete.
      x-schemaName: AdminBatchProductRequest
      properties:
        create:
          type: array
          description: The products to create.
          items:
            $ref: '#/components/schemas/AdminCreateProduct'
        update:
          type: array
          description: The products to update.
          items:
            $ref: '#/components/schemas/AdminUpdateProduct'
        delete:
          type: array
          description: The products to delete.
          items:
            type: string
            title: delete
            description: A product's ID.
    AdminBatchProductResponse:
      type: object
      description: The details of the products created, updated, or deleted.
      x-schemaName: AdminBatchProductResponse
      required:
        - created
        - updated
        - deleted
      properties:
        created:
          type: array
          description: The created products
          items:
            $ref: '#/components/schemas/AdminProduct'
        updated:
          type: array
          description: The updated products.
          items:
            $ref: '#/components/schemas/AdminProduct'
        deleted:
          type: object
          description: The deleted products' details.
          required:
            - ids
            - object
            - deleted
          properties:
            ids:
              type: array
              description: The IDs of deleted products.
              items:
                type: string
                title: ids
                description: The ID of a deleted product.
            object:
              type: string
              title: object
              description: The name of the deleted objects.
              default: product
            deleted:
              type: boolean
              title: deleted
              description: Whether the products were deleted.
    AdminBatchProductVariantRequest:
      type: object
      description: The product variants to create, update, or delete.
      x-schemaName: AdminBatchProductVariantRequest
      properties:
        create:
          type: array
          description: The product variants to create.
          items:
            $ref: '#/components/schemas/AdminCreateProductVariant'
        update:
          type: array
          description: The product variants to update.
          items:
            $ref: '#/components/schemas/AdminUpdateProductVariant'
        delete:
          type: array
          description: The product variants to delete.
          items:
            type: string
            title: delete
            description: A product variant's ID.
    AdminBatchProductVariantResponse:
      type: object
      description: The details of the product variants created, updated, or deleted.
      x-schemaName: AdminBatchProductVariantResponse
      required:
        - created
        - updated
        - deleted
      properties:
        created:
          type: array
          description: The created product variants.
          items:
            $ref: '#/components/schemas/AdminProductVariant'
        updated:
          type: array
          description: The updated product variants.
          items:
            $ref: '#/components/schemas/AdminProductVariant'
        deleted:
          type: object
          description: The details of the deleted product variants.
          required:
            - ids
            - object
            - deleted
          properties:
            ids:
              type: array
              description: The IDs of the deleted product variants.
              items:
                type: string
                title: ids
                description: The ID of a deleted variant.
            object:
              type: string
              title: object
              description: The name of the deleted objects.
              default: variant
            deleted:
              type: boolean
              title: deleted
              description: Whether the product variants were deleted.
    AdminCampaign:
      type: object
      description: The campaign's details.
      x-schemaName: AdminCampaign
      required:
        - id
        - name
        - description
        - currency
        - campaign_identifier
        - starts_at
        - ends_at
        - budget
      properties:
        id:
          type: string
          title: id
          description: The campaign's ID.
        name:
          type: string
          title: name
          description: The campaign's name.
        description:
          type: string
          title: description
          description: The campaign's description.
        currency:
          type: string
          title: currency
          description: The campaign's currency.
        campaign_identifier:
          type: string
          title: campaign_identifier
          description: The campaign's identifier.
        starts_at:
          type: string
          title: starts_at
          description: The date and time that the campaign starts.
        ends_at:
          type: string
          title: ends_at
          description: The date and time that the campaign ends.
        budget:
          type: object
          description: The campaign's budget.
          required:
            - id
            - type
            - currency_code
            - limit
            - used
          properties:
            id:
              type: string
              title: id
              description: The budget's ID.
            type:
              type: string
              description: |
                The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total number of times the campaign's promotions can be used.
              enum:
                - spend
                - usage
            currency_code:
              type: string
              title: currency_code
              description: The budget's currency code.
            limit:
              type: number
              title: limit
              description: The budget's limit.
            used:
              type: number
              title: used
              description: |
                How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's promotions have been used so far.
    AdminCampaignResponse:
      type: object
      description: The campaign's details.
      x-schemaName: AdminCampaignResponse
      required:
        - campaign
      properties:
        campaign:
          $ref: '#/components/schemas/AdminCampaign'
    AdminClaim:
      type: object
      description: The claim's details.
      x-schemaName: AdminClaim
      required:
        - order_id
        - claim_items
        - additional_items
        - currency_code
        - id
        - region_id
        - customer_id
        - sales_channel_id
        - email
        - shipping_methods
        - payment_status
        - fulfillment_status
        - summary
        - metadata
        - created_at
        - updated_at
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        id:
          type: string
          title: id
          description: The claim's ID.
        order_id:
          type: string
          title: order_id
          description: The ID of the order associated with the claim.
        claim_items:
          type: array
          description: The order items targetted by the claim.
          items:
            $ref: '#/components/schemas/BaseClaimItem'
        additional_items:
          type: array
          description: The outbound or new items of the claim.
          items:
            $ref: '#/components/schemas/BaseClaimItem'
        return:
          $ref: '#/components/schemas/Return'
        return_id:
          type: string
          title: return_id
          description: The ID of the associated return.
        no_notification:
          type: boolean
          title: no_notification
          description: Whether the customer should be notified about changes in the claim.
        refund_amount:
          type: number
          title: refund_amount
          description: The amount to be refunded.
        currency_code:
          type: string
          title: currency_code
          description: The claim's currency code.
        region_id:
          type: string
          title: region_id
          description: The ID of the region associated with the claim.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer associated with the claim's order.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The ID of the sales channel the claim's order is created in.
        email:
          type: string
          title: email
          description: The email associated with the claim's order.
          format: email
        display_id:
          type: number
          title: display_id
          description: The claim's display ID.
        shipping_address:
          $ref: '#/components/schemas/BaseOrderAddress'
        billing_address:
          $ref: '#/components/schemas/BaseOrderAddress'
        shipping_methods:
          type: array
          description: The claim's shipping methods.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethod'
        payment_collections:
          type: array
          description: The claim's payment collections.
          items:
            $ref: '#/components/schemas/BasePaymentCollection'
        payment_status:
          type: string
          description: The claim's payment status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
            - captured
            - partially_captured
            - partially_refunded
            - refunded
            - requires_action
        fulfillments:
          type: array
          description: The claim's fulfillments.
          items:
            $ref: '#/components/schemas/BaseOrderFulfillment'
        fulfillment_status:
          type: string
          description: The claim's fulfillment status.
          enum:
            - canceled
            - not_fulfilled
            - partially_fulfilled
            - fulfilled
            - partially_shipped
            - shipped
            - partially_delivered
            - delivered
        transactions:
          type: array
          description: The claim's transactions.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
            description: Learn more about transactions of orders and associated models.
          items:
            $ref: '#/components/schemas/BaseOrderTransaction'
        summary:
          $ref: '#/components/schemas/BaseOrderSummary'
        metadata:
          type: object
          description: The claim's metadata, used to store custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The claim's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The claim's update date.
        original_item_total:
          type: number
          title: original_item_total
          description: The total of the original items in the associated order.
        original_item_subtotal:
          type: number
          title: original_item_subtotal
          description: The subtotal of the original items in the associated order.
        original_item_tax_total:
          type: number
          title: original_item_tax_total
          description: The tax total of the original items in the associated order.
        item_total:
          type: number
          title: item_total
          description: The total of the claim's items.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The subtotal of the claim's items.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The tax total of the claim's items.
        original_total:
          type: number
          title: original_total
          description: The associated order's original total.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The associated order's original subtotal.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The associated order's original tax total.
        total:
          type: number
          title: total
          description: The associated order's total.
        subtotal:
          type: number
          title: subtotal
          description: The claim's subtotal.
        tax_total:
          type: number
          title: tax_total
          description: The claim's tax total.
        discount_total:
          type: number
          title: discount_total
          description: The claim's discount total.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The claim's discount tax total.
        gift_card_total:
          type: number
          title: gift_card_total
          description: The claim's gift card total.
        gift_card_tax_total:
          type: number
          title: gift_card_tax_total
          description: The claim's gift card tax total.
        shipping_total:
          type: number
          title: shipping_total
          description: The claim's shipping total.
        shipping_subtotal:
          type: number
          title: shipping_subtotal
          description: The claim's shipping subtotal.
        shipping_tax_total:
          type: number
          title: shipping_tax_total
          description: The claim's shipping tax total.
        original_shipping_total:
          type: number
          title: original_shipping_total
          description: The associated order's original shipping total.
        original_shipping_subtotal:
          type: number
          title: original_shipping_subtotal
          description: The associated order's original shipping subtotal.
        original_shipping_tax_total:
          type: number
          title: original_shipping_tax_total
          description: The associated order's original shipping tax total.
    AdminClaimDeleteResponse:
      type: object
      description: The details of the deleted claim.
      x-schemaName: AdminClaimDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The claim's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: claim
        deleted:
          type: boolean
          title: deleted
          description: Whether the claim was deleted.
    AdminClaimListResponse:
      type: object
      description: The paginated list of claims.
      x-schemaName: AdminClaimListResponse
      required:
        - limit
        - offset
        - count
        - claims
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total number of items.
        claims:
          type: array
          description: The list of claims.
          items:
            $ref: '#/components/schemas/AdminClaim'
    AdminClaimOrderResponse:
      type: object
      description: The created claim's details.
      x-schemaName: AdminClaimOrderResponse
      required:
        - order
        - claim
      properties:
        order:
          $ref: '#/components/schemas/Order'
        claim:
          $ref: '#/components/schemas/AdminClaim'
    AdminClaimPreviewResponse:
      type: object
      description: The details of the claim, as well as a preview of the order when the claim is applied.
      x-schemaName: AdminClaimPreviewResponse
      required:
        - order_preview
        - claim
      properties:
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
        claim:
          $ref: '#/components/schemas/AdminClaim'
    AdminClaimRequestResponse:
      type: object
      description: The details of the claim, its return, and a preview of the order when the claim is applied.
      x-schemaName: AdminClaimRequestResponse
      required:
        - return
        - order_preview
        - claim
      properties:
        return:
          $ref: '#/components/schemas/AdminReturn'
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
        claim:
          $ref: '#/components/schemas/AdminClaim'
    AdminClaimResponse:
      type: object
      description: The claim's details.
      x-schemaName: AdminClaimResponse
      required:
        - claim
      properties:
        claim:
          $ref: '#/components/schemas/AdminClaim'
    AdminClaimReturnPreviewResponse:
      type: object
      description: The details of the claim's return, with a preview of the order when the claim's return is applied.
      x-schemaName: AdminClaimReturnPreviewResponse
      required:
        - order_preview
        - return
      properties:
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
        return:
          $ref: '#/components/schemas/AdminReturn'
    AdminCollection:
      type: object
      description: The product collection's details.
      x-schemaName: AdminCollection
      required:
        - id
        - title
        - handle
        - created_at
        - updated_at
        - deleted_at
        - metadata
      properties:
        id:
          type: string
          title: id
          description: The collection's ID.
        title:
          type: string
          title: title
          description: The collection's title.
        handle:
          type: string
          title: handle
          description: The collection's handle.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The collection's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The collection's update date.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The collection's deletion date.
        products:
          type: array
          description: The collection's products.
          items:
            type: object
        metadata:
          type: object
          description: The collection's metadata, used to store custom key-value pairs.
    AdminCollectionDeleteResponse:
      type: object
      description: The details of the deleted collection.
      x-schemaName: AdminCollectionDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The collection's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: collection
        deleted:
          type: boolean
          title: deleted
          description: Whether the collection was deleted.
    AdminCollectionListResponse:
      type: object
      description: The paginated list of product collections.
      x-schemaName: AdminCollectionListResponse
      required:
        - limit
        - offset
        - count
        - collections
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned results.
        count:
          type: number
          title: count
          description: The total number of items.
        collections:
          type: array
          description: The list of product collections.
          items:
            $ref: '#/components/schemas/AdminCollection'
    AdminCollectionResponse:
      type: object
      description: The collection's details.
      x-schemaName: AdminCollectionResponse
      required:
        - collection
      properties:
        collection:
          $ref: '#/components/schemas/AdminCollection'
    AdminCreateApiKey:
      type: object
      description: The API key's details.
      x-schemaName: AdminCreateApiKey
      required:
        - title
        - type
      properties:
        title:
          type: string
          title: title
          description: The API key's title.
        type:
          type: string
          description: The API key's type. Use `secret` for a user's API key; Use `publishable` for Publishable API keys.
          enum:
            - publishable
            - secret
    AdminCreateApplicationMethod:
      type: object
      description: The application method's details.
      x-schemaName: AdminCreateApplicationMethod
      required:
        - value
        - type
        - target_type
      properties:
        description:
          type: string
          title: description
          description: The application method's description.
        value:
          type: number
          title: value
          description: The discounted amount applied by the associated promotion based on the `type`.
        currency_code:
          type: string
          title: currency_code
          description: The application method's currency code.
        max_quantity:
          type: number
          title: max_quantity
          description: The max quantity allowed in the cart for the associated promotion to be applied.
        type:
          type: string
          description: The type of the application method indicating how the associated promotion is applied.
          enum:
            - fixed
            - percentage
        target_type:
          type: string
          description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
          enum:
            - items
            - shipping_methods
            - order
        allocation:
          type: string
          description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
          enum:
            - each
            - across
        target_rules:
          type: array
          description: The application method's target rules.
          items:
            $ref: '#/components/schemas/AdminCreatePromotionRule'
        buy_rules:
          type: array
          description: The application method's buy rules.
          items:
            $ref: '#/components/schemas/AdminCreatePromotionRule'
        apply_to_quantity:
          type: number
          title: apply_to_quantity
          description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`.
        buy_rules_min_quantity:
          type: number
          title: buy_rules_min_quantity
          description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
    AdminCreateCollection:
      type: object
      description: the product collection's details.
      x-schemaName: AdminCreateCollection
      required:
        - title
      properties:
        title:
          type: string
          title: title
          description: The collection's title.
        handle:
          type: string
          title: handle
          description: The collection's handle.
        metadata:
          type: object
          description: The collection's metadata, used to store custom key-value pairs.
    AdminCreateCustomerGroup:
      type: object
      description: The customer group's details.
      x-schemaName: AdminCreateCustomerGroup
      required:
        - name
      properties:
        name:
          type: string
          title: name
          description: The customer group's name.
        metadata:
          type: object
          description: The customer group's metadata, used to store custom key-value pairs.
    AdminCreateFulfillment:
      type: object
      description: The filfillment's details.
      x-schemaName: AdminCreateFulfillment
      required:
        - location_id
        - provider_id
        - delivery_address
        - items
        - labels
        - order
        - order_id
        - data
        - metadata
      properties:
        location_id:
          type: string
          title: location_id
          description: The ID of the location the items are fulfilled from.
        provider_id:
          type: string
          title: provider_id
          description: The ID of the provider handling this fulfillment.
        delivery_address:
          type: object
          description: The address to deliver the items to.
          properties:
            first_name:
              type: string
              title: first_name
              description: The customer's first name.
            last_name:
              type: string
              title: last_name
              description: The customer's last name.
            phone:
              type: string
              title: phone
              description: The customer's phone.
            company:
              type: string
              title: company
              description: The delivery address's company.
            address_1:
              type: string
              title: address_1
              description: The delivery address's first line.
            address_2:
              type: string
              title: address_2
              description: The delivery address's second line.
            city:
              type: string
              title: city
              description: The delivery address's city.
            country_code:
              type: string
              title: country_code
              description: The delivery address's country code.
            province:
              type: string
              title: province
              description: The delivery address's province.
            postal_code:
              type: string
              title: postal_code
              description: The delivery address's postal code.
            metadata:
              type: object
              description: The delivery address's metadata, used to store custom key-value pairs.
        items:
          type: array
          description: The items to fulfill.
          items:
            type: object
            description: An item to fulfill.
            required:
              - title
              - sku
              - quantity
              - barcode
            properties:
              title:
                type: string
                title: title
                description: The item's title.
              sku:
                type: string
                title: sku
                description: The item's SKU.
              quantity:
                type: number
                title: quantity
                description: The quantity to fulfill of the item.
              barcode:
                type: string
                title: barcode
                description: The item's barcode.
              line_item_id:
                type: string
                title: line_item_id
                description: The ID of the associated line item.
              inventory_item_id:
                type: string
                title: inventory_item_id
                description: The ID of the inventory item associated with the underlying variant.
        labels:
          type: array
          description: The labels for the fulfillment's shipments.
          items:
            type: object
            description: A shipment's label.
            required:
              - tracking_number
              - tracking_url
              - label_url
            properties:
              tracking_number:
                type: string
                title: tracking_number
                description: The label's tracking number.
              tracking_url:
                type: string
                title: tracking_url
                description: The label's tracking URL.
              label_url:
                type: string
                title: label_url
                description: The label's URL.
        order_id:
          type: string
          title: order_id
          description: The ID of the order this fulfillment is created for.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the shipping option used in the order.
        data:
          type: object
          description: Any data useful for the fulfillment provider to handle the fulfillment.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
            description: Learn more about the data property.
        packed_at:
          type: string
          title: packed_at
          description: The date and time the fulfillment was packed.
          format: date-time
        shipped_at:
          type: string
          title: shipped_at
          description: The date and time the fulfillment was shipped.
          format: date-time
        delivered_at:
          type: string
          title: delivered_at
          description: The date and time the fulfillment was delivered.
          format: date-time
        canceled_at:
          type: string
          title: canceled_at
          description: The date and time the fulfillment was canceled.
          format: date-time
        metadata:
          type: object
          description: The fulfillment's metadata, used to store custom key-value pairs.
    AdminCreateInventoryItem:
      type: object
      description: The inventory item's details.
      x-schemaName: AdminCreateInventoryItem
      properties:
        sku:
          type: string
          title: sku
          description: The inventory item's SKU.
        hs_code:
          type: string
          title: hs_code
          description: The inventory item's HS code.
        weight:
          type: number
          title: weight
          description: The inventory item's weight.
        length:
          type: number
          title: length
          description: The inventory item's length.
        height:
          type: number
          title: height
          description: The inventory item's height.
        width:
          type: number
          title: width
          description: The inventory item's width.
        origin_country:
          type: string
          title: origin_country
          description: The inventory item's origin country.
        mid_code:
          type: string
          title: mid_code
          description: The inventory item's mid code.
        material:
          type: string
          title: material
          description: The inventory item's material.
        title:
          type: string
          title: title
          description: The inventory item's title.
        description:
          type: string
          title: description
          description: The description of the variant associated with the inventory item.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: Whether the item requires shipping.
        thumbnail:
          type: string
          title: thumbnail
          description: The inventory item's thumbnail.
        metadata:
          type: object
          description: The inventory item's metadata, used to store custom key-value pairs.
    AdminCreatePriceList:
      type: object
      description: The price list's details.
      x-schemaName: AdminCreatePriceList
      required:
        - title
        - description
      properties:
        title:
          type: string
          title: title
          description: The price list's title.
        description:
          type: string
          title: description
          description: The price list's description.
        starts_at:
          type: string
          title: starts_at
          description: The date and time the price list starts at.
          format: date-time
        ends_at:
          type: string
          title: ends_at
          description: The date and time the price list ends at.
          format: date-time
        status:
          type: string
          description: The price list's status.
          enum:
            - active
            - draft
        type:
          type: string
          description: The price list's type.
          enum:
            - sale
            - override
        rules:
          type: object
          description: The price list's rules.
          example:
            product_category_id: pcat_123
        prices:
          type: array
          description: The price list's prices.
          items:
            type: object
            description: A price's details.
            required:
              - currency_code
              - amount
              - variant_id
            properties:
              currency_code:
                type: string
                title: currency_code
                description: The price's currency code.
              amount:
                type: number
                title: amount
                description: The price's amount.
              variant_id:
                type: string
                title: variant_id
                description: The ID of the product variant this price is for.
              min_quantity:
                type: number
                title: min_quantity
                description: The minimum quantity required in the cart for this price to be applied.
              max_quantity:
                type: number
                title: max_quantity
                description: The maximum quantity in the cart that shouldn't be crossed for this price to be applied.
              rules:
                type: object
                description: The price's rules.
                example:
                  region_id: reg_123
    AdminCreatePricePreference:
      type: object
      description: The price preference's details.
      x-schemaName: AdminCreatePricePreference
      properties:
        attribute:
          type: string
          title: attribute
          description: The name of the attribute the price preference applies on.
          example: currency_code
        value:
          type: string
          title: value
          description: The attribute's value.
          example: usd
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: Whether the price is tax inclusive if the value of the specified attribute matches the specified value.
    AdminCreateProduct:
      type: object
      description: The product's details.
      x-schemaName: AdminCreateProduct
      required:
        - title
      properties:
        title:
          type: string
          title: title
          description: The product's title.
        subtitle:
          type: string
          title: subtitle
          description: The product's subtitle.
        description:
          type: string
          title: description
          description: The product's description.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: Whether the product is a gift card.
        discountable:
          type: boolean
          title: discountable
          description: Whether the product is discountable.
        images:
          type: array
          description: The product's images.
          items:
            type: object
            description: A product's image details.
            required:
              - url
            properties:
              url:
                type: string
                title: url
                description: The image's URL.
        thumbnail:
          type: string
          title: thumbnail
          description: The URL of the product's thumbnail.
        handle:
          type: string
          title: handle
          description: The product's handle.
        status:
          type: string
          description: The product's status.
          enum:
            - draft
            - proposed
            - published
            - rejected
        type_id:
          type: string
          title: type_id
          description: The ID of the type the product belongs to.
        collection_id:
          type: string
          title: collection_id
          description: The ID of the collection the product belongs to.
        categories:
          type: array
          description: The categories the product belongs to.
          items:
            type: object
            description: A category's details.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The category's ID.
        tags:
          type: array
          description: The product's tags.
          items:
            type: object
            description: A tag's details.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The tag's ID.
        options:
          type: array
          description: The product's options.
          items:
            $ref: '#/components/schemas/AdminCreateProductOption'
        variants:
          type: array
          description: The product's variants.
          items:
            $ref: '#/components/schemas/AdminCreateProductVariant'
        sales_channels:
          type: array
          description: The sales channels the product is available in.
          items:
            type: object
            description: A sales channel's details.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The sales channel's ID.
        weight:
          type: number
          title: weight
          description: The product's weight.
        length:
          type: number
          title: length
          description: The product's length.
        height:
          type: number
          title: height
          description: The product's height.
        width:
          type: number
          title: width
          description: The product's width.
        hs_code:
          type: string
          title: hs_code
          description: The product's HS code.
        mid_code:
          type: string
          title: mid_code
          description: The product's MID code.
        origin_country:
          type: string
          title: origin_country
          description: The product's origin country.
        material:
          type: string
          title: material
          description: The product's material.
        metadata:
          type: object
          description: The product's metadata, used to store custom key-value pairs.
    AdminCreateProductCategory:
      type: object
      description: The product category's details.
      x-schemaName: AdminCreateProductCategory
      required:
        - name
      properties:
        name:
          type: string
          title: name
          description: The product category's name.
        description:
          type: string
          title: description
          description: The product category's description.
        handle:
          type: string
          title: handle
          description: The product category's handle.
        is_internal:
          type: boolean
          title: is_internal
          description: Whether the product category is only used and seen by admin users.
        is_active:
          type: boolean
          title: is_active
          description: Whether the product category is active.
        parent_category_id:
          type: string
          title: parent_category_id
          description: The ID of a category that's the parent of this one.
        rank:
          type: number
          title: rank
          description: The sorting order of the product category among sibling categories.
        metadata:
          type: object
          description: The product category's metadata, used to store custom key-value pairs.
    AdminCreateProductOption:
      type: object
      description: The product option's details.
      x-schemaName: AdminCreateProductOption
      required:
        - title
        - values
      properties:
        title:
          type: string
          title: title
          description: The product option's title.
        values:
          type: array
          description: The product option's values.
          items:
            type: string
            title: values
            description: A value.
    AdminCreateProductTag:
      type: object
      description: The product tag's details.
      x-schemaName: AdminCreateProductTag
      required:
        - value
      properties:
        value:
          type: string
          title: value
          description: The product tag's value.
        metadata:
          type: object
          description: The product tag's metadata, used to store custom key-value pairs.
    AdminCreateProductVariant:
      type: object
      description: The product variant's details.
      x-schemaName: AdminCreateProductVariant
      required:
        - title
        - prices
      properties:
        title:
          type: string
          title: title
          description: The variant's title.
        sku:
          type: string
          title: sku
          description: The variant's SKU.
        ean:
          type: string
          title: ean
          description: The variant's EAN.
        upc:
          type: string
          title: upc
          description: The variant's UPC.
        barcode:
          type: string
          title: barcode
          description: The variant's barcode.
        hs_code:
          type: string
          title: hs_code
          description: The variant's HS code.
        mid_code:
          type: string
          title: mid_code
          description: The variant's MID code.
        allow_backorder:
          type: boolean
          title: allow_backorder
          description: Whether it's allowed to order this variant when it's out of stock.
        manage_inventory:
          type: boolean
          title: manage_inventory
          description: Whether Medusa manages the variant's inventory quantity. If disabled, the product variant is always considered in stock.
        variant_rank:
          type: number
          title: variant_rank
          description: The sorting order of the variant among other variants in the product.
        weight:
          type: number
          title: weight
          description: The variant's weight.
        length:
          type: number
          title: length
          description: The variant's length.
        height:
          type: number
          title: height
          description: The variant's height.
        width:
          type: number
          title: width
          description: The variant's width.
        origin_country:
          type: string
          title: origin_country
          description: The variant's origin country.
        material:
          type: string
          title: material
          description: The variant's material.
        metadata:
          type: object
          description: The variant's metadata, used to store custom key-value pairs.
        prices:
          type: array
          description: The variant's prices.
          items:
            $ref: '#/components/schemas/AdminCreateProductVariantPrice'
        options:
          type: object
          description: The variant's options, where the key is an option's name, and the value is the option's value.
          example:
            Color: Black
    AdminCreateProductVariantPrice:
      type: object
      description: The details of a variant's price.
      x-schemaName: AdminCreateProductVariantPrice
      required:
        - currency_code
        - amount
      properties:
        currency_code:
          type: string
          title: currency_code
          description: The price's currency code.
        amount:
          type: number
          title: amount
          description: The price's amount.
        min_quantity:
          type: number
          title: min_quantity
          description: The minimum quantity that must be available in the cart for this price to apply.
        max_quantity:
          type: number
          title: max_quantity
          description: The maximum quantity that must not be surpassed in the cart for this price to apply.
        rules:
          type: object
          description: The price's rules.
          example:
            region_id: reg_123
    AdminCreatePromotionRule:
      type: object
      description: The promotion rule's details.
      x-schemaName: AdminCreatePromotionRule
      required:
        - operator
        - attribute
        - values
      properties:
        operator:
          type: string
          description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
          enum:
            - gt
            - lt
            - eq
            - ne
            - in
            - lte
            - gte
        description:
          type: string
          title: description
          description: The rule's description.
        attribute:
          type: string
          title: attribute
          description: The attribute to compare against when checking whether a promotion can be applied on a cart.
          example: item.product.id
        values:
          oneOf:
            - type: string
              title: values
              description: The attribute's value.
              example: prod_123
            - type: array
              description: The allowed attribute values.
              items:
                type: string
                title: values
                description: An attribute value.
                example: prod_123
    AdminCreateRefundReason:
      type: object
      description: The refund reason's details.
      x-schemaName: AdminCreateRefundReason
      required:
        - label
      properties:
        label:
          type: string
          title: label
          description: The refund reason's label.
        description:
          type: string
          title: description
          description: The refund reason's description.
    AdminCreateRegion:
      type: object
      description: The region's details.
      x-schemaName: AdminCreateRegion
      required:
        - name
        - currency_code
      properties:
        name:
          type: string
          title: name
          description: The region's name.
        currency_code:
          type: string
          title: currency_code
          description: The region's currency code.
          example: usd
        countries:
          type: array
          description: The region's countries.
          items:
            type: string
            title: countries
            description: A country code.
            example: us
        automatic_taxes:
          type: boolean
          title: automatic_taxes
          description: Whether taxes are calculated automatically during checkout in this region.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: Whether prices in this region are tax inclusive.
        payment_providers:
          type: array
          description: The payment providers enabled in this region.
          items:
            type: string
            title: payment_providers
            description: A payment provider's ID.
            example: pp_stripe_stripe
        metadata:
          type: object
          description: The region's metadata, used to store custom key-value pairs.
    AdminCreateReservation:
      type: object
      description: The reservation's details.
      x-schemaName: AdminCreateReservation
      required:
        - location_id
        - inventory_item_id
        - quantity
      properties:
        line_item_id:
          type: string
          title: line_item_id
          description: The ID of the line item this reservation is created for.
        location_id:
          type: string
          title: location_id
          description: The ID of the location the quantity is reserved from.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The ID of the inventory item associated with the line item's variant.
        quantity:
          type: number
          title: quantity
          description: The reserved quantity.
        description:
          type: string
          title: description
          description: The reservation's description.
        metadata:
          type: object
          description: The reservation's metadata, used to store custom key-value pairs.
    AdminCreateSalesChannel:
      type: object
      description: The sales channel's details.
      x-schemaName: AdminCreateSalesChannel
      required:
        - name
      properties:
        name:
          type: string
          title: name
          description: The sales channel's name.
        description:
          type: string
          title: description
          description: The sales channel's description.
        is_disabled:
          type: boolean
          title: is_disabled
          description: Whether the sales channel is disabled.
        metadata:
          type: object
          description: The sales channel's metadata, used to store custom key-value pairs.
    AdminCreateShipment:
      type: object
      description: The shipment's details.
      x-schemaName: AdminCreateShipment
      required:
        - labels
      properties:
        labels:
          type: array
          description: The shipment's labels.
          items:
            type: object
            description: A shipment label's details.
            required:
              - tracking_number
              - tracking_url
              - label_url
            properties:
              tracking_number:
                type: string
                title: tracking_number
                description: The label's tracking number.
              tracking_url:
                type: string
                title: tracking_url
                description: The label's tracking URL.
              label_url:
                type: string
                title: label_url
                description: The label's URL.
    AdminCreateShippingOption:
      type: object
      description: The shipping option's details.
      x-schemaName: AdminCreateShippingOption
      required:
        - name
        - service_zone_id
        - shipping_profile_id
        - price_type
        - provider_id
        - type
        - prices
      properties:
        name:
          type: string
          title: name
          description: The shipping option's name.
        service_zone_id:
          type: string
          title: service_zone_id
          description: The ID of the service zone this shipping option belongs to.
        shipping_profile_id:
          type: string
          title: shipping_profile_id
          description: The ID of the shipping profile this shipping option belongs to.
        data:
          type: object
          description: Any data necessary for fulfillment providers to handle shipping methods and fulfillments of this shipping option.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
            description: Learn more about the data property.
        price_type:
          type: string
          description: |
            The shipping option price's type. If `flat`, it means the option has a fixed price set in the `prices` property. `calculated` means that the shipping option's price is calculated during checkout.
          enum:
            - flat
            - calculated
        provider_id:
          type: string
          title: provider_id
          description: The ID of the fulfillment provider used to handle this shipping option and its associated methods and fulfillments.
        type:
          type: object
        prices:
          type: array
          description: The shipping option's prices. If `price_type` is `calculated`, pass an empty array for this property.
          items:
            oneOf:
              - type: object
                description: The price for a currency code.
                x-schemaName: AdminCreateShippingOptionPriceWithCurrency
                required:
                  - currency_code
                  - amount
                properties:
                  currency_code:
                    type: string
                    title: currency_code
                    description: The price's currency code.
                  amount:
                    type: number
                    title: amount
                    description: The price's amount.
              - type: object
                description: The price in a region.
                x-schemaName: AdminCreateShippingOptionPriceWithRegion
                required:
                  - region_id
                  - amount
                properties:
                  region_id:
                    type: string
                    title: region_id
                    description: The ID of the region this price is used in.
                  amount:
                    type: number
                    title: amount
                    description: The price's amount.
        rules:
          type: array
          description: The shipping option's rules.
          items:
            $ref: '#/components/schemas/AdminCreateShippingOptionRule'
    AdminCreateShippingOptionRule:
      type: object
      description: The details of the shipping option rule.
      x-schemaName: AdminCreateShippingOptionRule
      required:
        - operator
        - attribute
        - value
      properties:
        operator:
          type: string
          description: The operator used to check whether a rule applies.
          enum:
            - gt
            - lt
            - eq
            - ne
            - in
            - lte
            - gte
            - nin
        attribute:
          type: string
          title: attribute
          description: The name of a property or table that the rule applies to.
          example: customer_group
        value:
          oneOf:
            - type: string
              title: value
              description: A value of the attribute that enables this rule.
              example: cusgroup_123
            - type: array
              description: Values of the attribute that enable this rule.
              items:
                type: string
                title: value
                description: A value of the attribute that enables this rule.
                example: cusgroup_123
    AdminCreateShippingProfile:
      type: object
      description: The shipping profile's details.
      x-schemaName: AdminCreateShippingProfile
      required:
        - name
        - type
      properties:
        name:
          type: string
          title: name
          description: The shipping profile's name.
        type:
          type: string
          title: type
          description: The shipping profile's type.
        metadata:
          type: object
          description: The shipping profile's metadata, used to store custom key-value pairs.
    AdminCreateStockLocation:
      type: object
      description: The stock location's details.
      x-schemaName: AdminCreateStockLocation
      required:
        - name
      properties:
        name:
          type: string
          title: name
          description: The stock location's name.
        address_id:
          type: string
          title: address_id
          description: The ID of the stock location's address.
        address:
          $ref: '#/components/schemas/AdminUpsertStockLocationAddress'
        metadata:
          type: object
          description: The stock location's metadata, used to store custom key-value pairs.
    AdminCreateTaxRate:
      type: object
      description: The tax rate's details.
      x-schemaName: AdminCreateTaxRate
      required:
        - name
        - tax_region_id
      properties:
        name:
          type: string
          title: name
          description: The tax rate's name.
          example: VAT
        tax_region_id:
          type: string
          title: tax_region_id
          description: The ID of the tax region this rate belongs to.
        rate:
          type: number
          title: rate
          description: The rate to charge.
          example: 10
        code:
          type: string
          title: code
          description: The code the tax rate is identified by.
        rules:
          type: array
          description: The tax rate's rules.
          items:
            $ref: '#/components/schemas/AdminCreateTaxRateRule'
        is_default:
          type: boolean
          title: is_default
          description: Whether the tax rate is the default in its tax region.
        is_combinable:
          type: boolean
          title: is_combinable
          description: Whether the tax rate should be combined with parent rates.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
        metadata:
          type: object
          description: The tax rate's metadata, used to store custom key-value pairs.
    AdminCreateTaxRateRule:
      type: object
      description: The tax rate rule's details.
      x-schemaName: AdminCreateTaxRateRule
      required:
        - reference
        - reference_id
      properties:
        reference:
          type: string
          title: reference
          description: The name of a table in the database that this rule points to.
          example: product_type
        reference_id:
          type: string
          title: reference_id
          description: The ID of a record in the table specified in reference.
          example: ptype_123
    AdminCreateTaxRegion:
      type: object
      description: The tax region's details.
      x-schemaName: AdminCreateTaxRegion
      required:
        - country_code
      properties:
        country_code:
          type: string
          title: country_code
          description: The tax region's country code.
          example: us
        province_code:
          type: string
          title: province_code
          description: The tax region's province code.
        parent_id:
          type: string
          title: parent_id
          description: The ID of the parent tax region.
        default_tax_rate:
          type: object
          description: The tax region's default tax rate.
          required:
            - name
          properties:
            rate:
              type: number
              title: rate
              description: The rate to charge.
              example: 10
            code:
              type: string
              title: code
              description: The code the tax rate is identified by
            name:
              type: string
              title: name
              description: The default tax rate's name.
              example: VAT
            is_combinable:
              type: boolean
              description: Whether the tax rate should be combined with parent rates.
              externalDocs:
                url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
            metadata:
              type: object
              description: The default tax rate's metadata, used to store custom key-value pairs.
        metadata:
          type: object
          description: The tax region's metadata, used to store custom key-value pairs.
    AdminCreateVariantInventoryItem:
      type: object
      description: The details of the variant-inventory item association.
      x-schemaName: AdminCreateVariantInventoryItem
      required:
        - required_quantity
        - inventory_item_id
      properties:
        required_quantity:
          type: number
          title: required_quantity
          description: The quantity of the variant in the inventory item.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The inventory item's ID.
    AdminCreateWorkflowsAsyncResponse:
      type: object
      description: The details of changing a workflow execution's step status.
      x-schemaName: AdminCreateWorkflowsAsyncResponse
      required:
        - transaction_id
        - step_id
      properties:
        transaction_id:
          type: string
          title: transaction_id
          description: The workflows execution's transaction ID.
        step_id:
          type: string
          title: step_id
          description: The ID of the step whose status was changed.
        response:
          description: Sets the step's response. It accepts any type.
        compensate_input:
          description: Sets the compensation function's input. It accepts any response.
        action:
          type: string
          description: Whether to invoke or compensate the step.
          enum:
            - invoke
            - compensate
    AdminCreateWorkflowsRun:
      type: object
      description: The details of the workflow to execute.
      x-schemaName: AdminCreateWorkflowsRun
      properties:
        input:
          description: The input to pass to the workflow. Can be of any type.
        transaction_id:
          type: string
          title: transaction_id
          description: The ID of the workflow execution's transaction.
    AdminCurrency:
      type: object
      description: The currency's currencies.
      x-schemaName: AdminCurrency
      required:
        - code
        - symbol
        - symbol_native
        - name
        - decimal_digits
        - rounding
        - raw_rounding
        - created_at
        - updated_at
        - deleted_at
      properties:
        code:
          type: string
          title: code
          description: The currency's code.
          example: usd
        symbol:
          type: string
          title: symbol
          description: The currency's symbol.
          example: $
        symbol_native:
          type: string
          title: symbol_native
          description: The currency's native symbol, if different than the symbol.
          example: $
        name:
          type: string
          title: name
          description: The currency's name.
        decimal_digits:
          type: number
          title: decimal_digits
          description: The number of digits after the decimal for prices in this currency.
        rounding:
          type: number
          title: rounding
          description: The rounding percision applied on prices in this currency.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The currency's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The currency's update date.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The currency's deletion date.
    AdminCurrencyListResponse:
      type: object
      description: The paginated list of currencies.
      x-schemaName: AdminCurrencyListResponse
      required:
        - limit
        - offset
        - count
        - currencies
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total number of items.
        currencies:
          type: array
          description: The list of currencies.
          items:
            $ref: '#/components/schemas/AdminCurrency'
    AdminCurrencyResponse:
      type: object
      description: The currency's details.
      x-schemaName: AdminCurrencyResponse
      required:
        - currency
      properties:
        currency:
          $ref: '#/components/schemas/AdminCurrency'
    AdminCustomer:
      type: object
      description: The customer's details.
      x-schemaName: AdminCustomer
      required:
        - has_account
        - id
        - email
        - default_billing_address_id
        - default_shipping_address_id
        - company_name
        - first_name
        - last_name
        - addresses
      properties:
        id:
          type: string
          title: id
          description: The customer's ID.
        has_account:
          type: boolean
          title: has_account
          description: Whether the customer is registered.
        groups:
          type: array
          description: The customer's groups.
          items:
            $ref: '#/components/schemas/AdminCustomerGroup'
        email:
          type: string
          title: email
          description: The customer's email.
          format: email
        default_billing_address_id:
          type: string
          title: default_billing_address_id
          description: The ID of the address used as the default billing address.
        default_shipping_address_id:
          type: string
          title: default_shipping_address_id
          description: The ID of the address used as the default shipping address.
        company_name:
          type: string
          title: company_name
          description: The customer's company name.
        first_name:
          type: string
          title: first_name
          description: The customer's first name.
        last_name:
          type: string
          title: last_name
          description: The customer's last name.
        addresses:
          type: array
          description: The customer's addresses.
          items:
            $ref: '#/components/schemas/BaseCustomerAddress'
        phone:
          type: string
          title: phone
          description: The customer's phone.
        metadata:
          type: object
          description: The customer's metadata, used to store custom key-value pairs.
        created_by:
          type: string
          title: created_by
          description: The ID of the user that created this customer, if available.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The customer's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The customer's update date.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The customer's deletion date.
    AdminCustomerAddress:
      type: object
      description: The customer's address.
      x-schemaName: AdminCustomerAddress
      required:
        - id
        - address_name
        - is_default_shipping
        - is_default_billing
        - customer_id
        - company
        - first_name
        - last_name
        - address_1
        - address_2
        - city
        - country_code
        - province
        - postal_code
        - phone
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The address's ID.
        address_name:
          type: string
          title: address_name
          description: The address's name.
        is_default_shipping:
          type: boolean
          title: is_default_shipping
          description: Whether the address is the default shipping address.
        is_default_billing:
          type: boolean
          title: is_default_billing
          description: Whether the address is the default billing address.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer that this address belongs to.
        company:
          type: string
          title: company
          description: The customer's company.
        first_name:
          type: string
          title: first_name
          description: The customer's first name.
        last_name:
          type: string
          title: last_name
          description: The customer's last name.
        address_1:
          type: string
          title: address_1
          description: The address's first line.
        address_2:
          type: string
          title: address_2
          description: The address's second line.
        city:
          type: string
          title: city
          description: The address's city.
        country_code:
          type: string
          title: country_code
          description: The address's country code.
          example: us
        province:
          type: string
          title: province
          description: The address's province.
        postal_code:
          type: string
          title: postal_code
          description: The address's postal code.
        phone:
          type: string
          title: phone
          description: The address's phone.
        metadata:
          type: object
          description: The address's metadata, used to store custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The address's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The address's update date.
    AdminCustomerAddressResponse:
      type: object
      description: The address's details.
      x-schemaName: AdminCustomerAddressResponse
      required:
        - address
      properties:
        address:
          $ref: '#/components/schemas/AdminCustomerAddress'
    AdminCustomerGroup:
      type: object
      description: The customer group's details.
      x-schemaName: AdminCustomerGroup
      required:
        - id
        - name
        - customers
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The customer group's ID.
        name:
          type: string
          title: name
          description: The customer group's name.
        customers:
          type: array
          description: The customer group's customers.
          items:
            $ref: '#/components/schemas/BaseCustomer'
        metadata:
          type: object
          description: The customer group's metadata, used to store custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The customer group's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The customer group's update date.
    AdminCustomerGroupResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminCustomerGroupResponse
      required:
        - customer_group
      properties:
        customer_group:
          $ref: '#/components/schemas/AdminCustomerGroup'
    AdminCustomerInGroupFilters:
      type: object
      description: Filters to apply on customers to retrieve their groups.
      x-schemaName: AdminCustomerInGroupFilters
      properties:
        id:
          oneOf:
            - type: string
              title: id
              description: Filter by a customer's ID.
            - type: array
              description: Filter by customer IDs.
              items:
                type: string
                title: id
                description: A customer's ID.
        email:
          oneOf:
            - type: string
              title: email
              description: Filter by a customer's email.
              format: email
            - type: array
              description: Filter by customer emails.
              items:
                type: string
                title: email
                description: A customer's email.
                format: email
            - type: object
              description: Apply filters on the customer's email.
              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 exact matches
                      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`).
        default_billing_address_id:
          oneOf:
            - type: string
              title: default_billing_address_id
              description: Filter by the ID of a customer's default billing address.
            - type: array
              description: Filter by the IDs of a customers' default billing address.
              items:
                type: string
                title: default_billing_address_id
                description: The ID of a customer's default billing address.
        default_shipping_address_id:
          oneOf:
            - type: string
              title: default_shipping_address_id
              description: Filter by the ID of a customer's default shipping address.
            - type: array
              description: Filter by the IDs of a customers' default shipping address.
              items:
                type: string
                title: default_shipping_address_id
                description: The ID of a customer's default shipping address.
        company_name:
          oneOf:
            - type: string
              title: company_name
              description: Filter by a customer's company name.
            - type: array
              description: Filter by customers' company names.
              items:
                type: string
                title: company_name
                description: A company name.
        first_name:
          oneOf:
            - type: string
              title: first_name
              description: Filter by a customer's first name.
            - type: array
              description: Filter by customers' first names.
              items:
                type: string
                title: first_name
                description: A first name.
        last_name:
          oneOf:
            - type: string
              title: last_name
              description: Filter by a customer's last name.
            - type: array
              description: Filter by customers' last names.
              items:
                type: string
                title: last_name
                description: A last name.
        created_by:
          oneOf:
            - type: string
              title: created_by
              description: Filter by the ID of a user to retrieve the groups of the customers they created.
            - type: array
              description: Filter by the ID of users to retrieve the groups of the customers they created.
              items:
                type: string
                title: created_by
                description: A user's ID.
        created_at:
          type: object
          description: Filter the customer'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 exact matches
                  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`).
        updated_at:
          type: object
          description: Filter the customer'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`).
        deleted_at:
          type: object
          description: Filter the customer'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`).
    AdminCustomerResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminCustomerResponse
      required:
        - customer
      properties:
        customer:
          $ref: '#/components/schemas/AdminCustomer'
    AdminDeletePaymentCollectionResponse:
      type: object
      description: The result of deleting the payment collection.
      x-schemaName: AdminDeletePaymentCollectionResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The payment collection's ID.
        object:
          type: string
          title: object
          description: The name of the object that was deleted.
          default: payment-collection
        deleted:
          type: boolean
          title: deleted
          description: Whether the object was deleted.
    AdminDraftOrderResponse:
      type: object
      description: The draft order's details.
      x-schemaName: AdminDraftOrderResponse
      required:
        - draft_order
      properties:
        draft_order:
          $ref: '#/components/schemas/AdminOrder'
    AdminExchange:
      type: object
      description: The exchange's details.
      x-schemaName: AdminExchange
      required:
        - order_id
        - return_items
        - additional_items
        - currency_code
        - id
        - region_id
        - customer_id
        - sales_channel_id
        - email
        - shipping_methods
        - payment_status
        - fulfillment_status
        - summary
        - metadata
        - created_at
        - updated_at
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        order_id:
          type: string
          title: order_id
          description: The ID of the order the exchange is created for.
        return_items:
          type: array
          description: The items returned (inbound) by the exchange.
          items:
            $ref: '#/components/schemas/AdminReturnItem'
        additional_items:
          type: array
          description: The new items (outbound) sent by the exchange.
          items:
            $ref: '#/components/schemas/BaseExchangeItem'
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send the customer notifications when the exchange is updated.
        difference_due:
          type: number
          title: difference_due
          description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
        return:
          description: the return associated with the exchange.
          $ref: '#/components/schemas/AdminReturn'
        return_id:
          type: string
          title: return_id
          description: The ID of the associated exchange.
        currency_code:
          type: string
          title: currency_code
          description: The exchange's currency code.
        id:
          type: string
          title: id
          description: The exchange's ID.
        region_id:
          type: string
          title: region_id
          description: The ID of the associated order's region.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer that placed the order.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The ID of the sales channel the associated order belongs to.
        email:
          type: string
          title: email
          description: The email used when placing the order.
          format: email
        display_id:
          type: number
          title: display_id
          description: The exchange's display ID.
        shipping_address:
          description: The shipping address to send new items to.
          $ref: '#/components/schemas/BaseOrderAddress'
        billing_address:
          description: The customer's billing address.
          $ref: '#/components/schemas/BaseOrderAddress'
        shipping_methods:
          type: array
          description: The shipping methods used to send the new (outbound) items.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethod'
        payment_collections:
          type: array
          description: The exchange's payment collections.
          items:
            $ref: '#/components/schemas/BasePaymentCollection'
        payment_status:
          type: string
          description: The exchange's payment status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
            - captured
            - partially_captured
            - partially_refunded
            - refunded
            - requires_action
        fulfillments:
          type: array
          description: The exchange's fulfillments of new (outbound) items.
          items:
            $ref: '#/components/schemas/BaseOrderFulfillment'
        fulfillment_status:
          type: string
          description: The exchange's fulfillment status.
          enum:
            - canceled
            - not_fulfilled
            - partially_fulfilled
            - fulfilled
            - partially_shipped
            - shipped
            - partially_delivered
            - delivered
        transactions:
          type: array
          description: The exchange's transactions.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
          items:
            $ref: '#/components/schemas/BaseOrderTransaction'
        summary:
          description: The totals summary of the exchange.
          $ref: '#/components/schemas/BaseOrderSummary'
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date that the exchange was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date that the exchange was updated.
        original_item_total:
          type: number
          title: original_item_total
          description: The total of the original items in the order.
        original_item_subtotal:
          type: number
          title: original_item_subtotal
          description: The subtotal of the original items in the order.
        original_item_tax_total:
          type: number
          title: original_item_tax_total
          description: The total tax of the original items in the order.
        item_total:
          type: number
          title: item_total
          description: The total of the exchange's new items.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The subtotal of the exchange's new items.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The tax total of the exchange's new items.
        original_total:
          type: number
          title: original_total
          description: The total of the order.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The subtotal of the order.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The tax total of the order.
        total:
          type: number
          title: total
          description: The total of the exchange.
        subtotal:
          type: number
          title: subtotal
          description: The subtotal of the exchange.
        tax_total:
          type: number
          title: tax_total
          description: The tax total of the exchange.
        discount_total:
          type: number
          title: discount_total
          description: The discount total of the exchange.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The total taxes on discount of the exchange.
        gift_card_total:
          type: number
          title: gift_card_total
          description: The gift cards total of the exchange.
        gift_card_tax_total:
          type: number
          title: gift_card_tax_total
          description: The total taxes on the gift card of the exchange.
        shipping_total:
          type: number
          title: shipping_total
          description: The exchange's shipping total.
        shipping_subtotal:
          type: number
          title: shipping_subtotal
          description: The exchange's shipping subtotal.
        shipping_tax_total:
          type: number
          title: shipping_tax_total
          description: The exchange's shipping tax total.
        original_shipping_total:
          type: number
          title: original_shipping_total
          description: The order's shipping total.
        original_shipping_subtotal:
          type: number
          title: original_shipping_subtotal
          description: The order's shipping subtotal.
        original_shipping_tax_total:
          type: number
          title: original_shipping_tax_total
          description: The order's shipping tax total.
    AdminExchangeDeleteResponse:
      type: object
      description: The details of deleting an exchange.
      x-schemaName: AdminExchangeDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The exchange's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: exchange
        deleted:
          type: boolean
          title: deleted
          description: Whether the exchange was deleted.
    AdminExchangeOrderResponse:
      type: object
      description: The exchange's details.
      x-schemaName: AdminExchangeOrderResponse
      required:
        - order
        - exchange
      properties:
        order:
          description: The details of the associated order.
          $ref: '#/components/schemas/Order'
        exchange:
          $ref: '#/components/schemas/AdminExchange'
    AdminExchangePreviewResponse:
      type: object
      description: A preview of the order once the exchange is applied.
      x-schemaName: AdminExchangePreviewResponse
      required:
        - order_preview
        - exchange
      properties:
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
        exchange:
          $ref: '#/components/schemas/AdminExchange'
    AdminExchangeRequestResponse:
      type: object
      description: The details of a requested exchange.
      x-schemaName: AdminExchangeRequestResponse
      required:
        - return
        - order_preview
        - exchange
      properties:
        return:
          description: The associated return's details.
          $ref: '#/components/schemas/AdminReturn'
        order_preview:
          description: A preview of the order once the exchange is applied.
          $ref: '#/components/schemas/OrderPreview'
        exchange:
          $ref: '#/components/schemas/AdminExchange'
    AdminExchangeResponse:
      type: object
      description: The exchange's details.
      x-schemaName: AdminExchangeResponse
      required:
        - exchange
      properties:
        exchange:
          $ref: '#/components/schemas/AdminExchange'
    AdminExchangeReturnResponse:
      type: object
      description: The details of an exchange's return.
      x-schemaName: AdminExchangeReturnResponse
      required:
        - order_preview
        - return
      properties:
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
        return:
          $ref: '#/components/schemas/AdminReturn'
    AdminExportProductResponse:
      type: object
      description: The details of the product export.
      x-schemaName: AdminExportProductResponse
      required:
        - transaction_id
      properties:
        transaction_id:
          type: string
          title: transaction_id
          description: The ID of the workflow execution's transaction. Use it to check the status of the export by sending a GET request to `/admin/workflows-executions/export-products/:transaction-id`
    AdminFile:
      type: object
      description: A file's details.
      x-schemaName: AdminFile
      required:
        - id
        - url
      properties:
        id:
          type: string
          title: id
          description: The file's ID.
        url:
          type: string
          title: url
          description: The file's URL.
    AdminFileListResponse:
      type: object
      description: The list of uploaded files.
      x-schemaName: AdminFileListResponse
      required:
        - files
      properties:
        files:
          type: array
          description: The list of uploaded files.
          items:
            $ref: '#/components/schemas/AdminFile'
    AdminFileResponse:
      type: object
      description: A file's details.
      x-schemaName: AdminFileResponse
      required:
        - file
      properties:
        file:
          $ref: '#/components/schemas/AdminFile'
    AdminFulfillment:
      type: object
      description: The fulfillment's details.
      x-schemaName: AdminFulfillment
      required:
        - id
        - location_id
        - provider_id
        - shipping_option_id
        - provider
        - delivery_address
        - items
        - labels
        - packed_at
        - shipped_at
        - delivered_at
        - canceled_at
        - data
        - metadata
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The fulfillment's ID.
        location_id:
          type: string
          title: location_id
          description: The ID of the location the fulfillment's items are shipped from.
        provider_id:
          type: string
          title: provider_id
          description: The ID of the fulfillment provider handling this fulfillment.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the shipping option this fulfillment is created for.
        provider:
          description: The details of the fulfillment provider using to handle this fulfillment.
          $ref: '#/components/schemas/AdminFulfillmentProvider'
        delivery_address:
          description: The address to deliver the item to.
          $ref: '#/components/schemas/AdminFulfillmentAddress'
        items:
          type: array
          description: The fulfillment's items.
          items:
            $ref: '#/components/schemas/AdminFulfillmentItem'
        labels:
          type: array
          description: The fulfillment's shipment labels.
          items:
            $ref: '#/components/schemas/AdminFulfillmentLabel'
        packed_at:
          type: string
          title: packed_at
          description: The date the fulfillment was packed at.
        shipped_at:
          type: string
          title: shipped_at
          description: The date the fulfillment was shipped at.
        delivered_at:
          type: string
          title: delivered_at
          description: The date the fulfillment was delivered at.
        canceled_at:
          type: string
          title: canceled_at
          description: The date the fulfillment was canceled at.
        data:
          type: object
          description: The fulfillment's data, useful for the third-party provider handling the fulfillment.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
        metadata:
          type: object
          description: The fulfillment's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the fulfillment was created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the fulfillment was updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the fulfillment was deleted at.
    AdminFulfillmentAddress:
      type: object
      description: An address's details.
      x-schemaName: AdminFulfillmentAddress
      required:
        - id
        - fulfillment_id
        - company
        - first_name
        - last_name
        - address_1
        - address_2
        - city
        - country_code
        - province
        - postal_code
        - phone
        - metadata
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The address's ID.
        fulfillment_id:
          type: string
          title: fulfillment_id
          description: The ID of the fulfillment that the address belongs to.
        company:
          type: string
          title: company
          description: The address's company.
        first_name:
          type: string
          title: first_name
          description: The address's first name.
        last_name:
          type: string
          title: last_name
          description: The address's last name.
        address_1:
          type: string
          title: address_1
          description: The address's first line.
        address_2:
          type: string
          title: address_2
          description: The address's second line.
        city:
          type: string
          title: city
          description: The address's city.
        country_code:
          type: string
          title: country_code
          description: The address's country code.
        province:
          type: string
          title: province
          description: The address's province.
        postal_code:
          type: string
          title: postal_code
          description: The address's postal code.
        phone:
          type: string
          title: phone
          description: The address's phone.
        metadata:
          type: object
          description: The address's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the address was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the address was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the address was deleted.
    AdminFulfillmentItem:
      type: object
      description: The details of a fulfillment's item.
      x-schemaName: AdminFulfillmentItem
      required:
        - id
        - title
        - quantity
        - sku
        - barcode
        - line_item_id
        - inventory_item_id
        - fulfillment_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The item's ID.
        title:
          type: string
          title: title
          description: The item's title.
        quantity:
          type: number
          title: quantity
          description: The item's quantity to be fulfilled.
        sku:
          type: string
          title: sku
          description: The item's SKU.
        barcode:
          type: string
          title: barcode
          description: The item's barcode.
        line_item_id:
          type: string
          title: line_item_id
          description: The ID of the order's line item to be fulfilled.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The ID of the inventory item of the underlying product variant.
        fulfillment_id:
          type: string
          title: fulfillment_id
          description: The ID of the fulfillment the item belongs to.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the item was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the item was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the item was deleted.
    AdminFulfillmentLabel:
      type: object
      description: The details of a fulfillmet's shipment label.
      x-schemaName: AdminFulfillmentLabel
      required:
        - id
        - tracking_number
        - tracking_url
        - label_url
        - fulfillment_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The label's ID.
        tracking_number:
          type: string
          title: tracking_number
          description: The label's tracking number.
        tracking_url:
          type: string
          title: tracking_url
          description: The label's tracking URL.
        label_url:
          type: string
          title: label_url
          description: The label's URL.
        fulfillment_id:
          type: string
          title: fulfillment_id
          description: The ID of the fulfillment the label is associated with.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the label was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the label was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the label was deleted.
    AdminFulfillmentProvider:
      type: object
      description: The shipping option's provider.
      x-schemaName: AdminFulfillmentProvider
    AdminFulfillmentProviderListResponse:
      type: object
      description: The paginated list of fulfillment providers.
      x-schemaName: AdminFulfillmentProviderListResponse
      required:
        - limit
        - offset
        - count
        - fulfillment_providers
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total count of items.
        fulfillment_providers:
          type: array
          description: The list of fulfillment providers.
          items:
            $ref: '#/components/schemas/AdminFulfillmentProvider'
    AdminFulfillmentResponse:
      type: object
      description: A fulfillment's details.
      x-schemaName: AdminFulfillmentResponse
      required:
        - fulfillment
      properties:
        fulfillment:
          $ref: '#/components/schemas/AdminFulfillment'
    AdminFulfillmentSet:
      type: object
      description: The fulfillment set's parent.
      x-schemaName: AdminFulfillmentSet
      required:
        - id
        - name
        - type
        - location
        - service_zones
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The parent's ID.
        name:
          type: string
          title: name
          description: The parent's name.
        type:
          type: string
          title: type
          description: The parent's type.
        location:
          $ref: '#/components/schemas/AdminStockLocation'
        service_zones:
          type: array
          description: The parent's service zones.
          items:
            $ref: '#/components/schemas/AdminServiceZone'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The parent's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The parent's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The parent's deleted at.
    AdminFulfillmentSetDeleteResponse:
      type: object
      description: The deletion details.
      x-schemaName: AdminFulfillmentSetDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The fulfillment set's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: fulfillment_set
        deleted:
          type: boolean
          title: deleted
          description: Whether the fulfillment set was deleted.
    AdminFulfillmentSetResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminFulfillmentSetResponse
      required:
        - fulfillment_set
      properties:
        fulfillment_set:
          $ref: '#/components/schemas/AdminFulfillmentSet'
    AdminGeoZone:
      type: object
      description: The geo zone's details.
      x-schemaName: AdminGeoZone
      required:
        - id
        - type
        - country_code
        - province_code
        - city
        - postal_expression
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The geo zone's ID.
        type:
          type: string
          description: The geo zone's type.
          enum:
            - country
            - province
            - city
            - zip
        country_code:
          type: string
          title: country_code
          description: The geo zone's country code.
        province_code:
          type: string
          title: province_code
          description: The geo zone's province code.
        city:
          type: string
          title: city
          description: The geo zone's city.
        postal_expression:
          type: object
          description: The geo zone's postal expression.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the geo zone was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the geo zone was update.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the geo zone was deleted.
    AdminImportProductRequest:
      type: object
      description: The import's details.
      x-schemaName: AdminImportProductRequest
      required:
        - file
      properties:
        file:
          $ref: '#/components/schemas/File'
    AdminImportProductResponse:
      type: object
      description: The import process's details.
      x-schemaName: AdminImportProductResponse
      required:
        - transaction_id
        - summary
      properties:
        transaction_id:
          type: string
          title: transaction_id
          description: The ID of the workflow execution's transaction. This is useful to confirm the import using the `/admin/products/:transaction-id/import` API route.
        summary:
          type: object
          description: The import's summary.
          required:
            - toCreate
            - toUpdate
          properties:
            toCreate:
              type: number
              title: toCreate
              description: The number of products that will be created by this import.
            toUpdate:
              type: number
              title: toUpdate
              description: The number of products that will be updated by this import.
    AdminInventoryItem:
      type: object
      description: The inventory item's details.
      x-schemaName: AdminInventoryItem
      required:
        - id
        - requires_shipping
      properties:
        id:
          type: string
          title: id
          description: The inventory item's ID.
        sku:
          type: string
          title: sku
          description: The inventory item's SKU.
        origin_country:
          type: string
          title: origin_country
          description: The inventory item's origin country.
        hs_code:
          type: string
          title: hs_code
          description: The inventory item's HS code.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: Whether the inventory item requires shipping.
        mid_code:
          type: string
          title: mid_code
          description: The inventory item's MID code.
        material:
          type: string
          title: material
          description: The inventory item's material.
        weight:
          type: number
          title: weight
          description: The inventory item's weight.
        length:
          type: number
          title: length
          description: The inventory item's length.
        height:
          type: number
          title: height
          description: The inventory item's height.
        width:
          type: number
          title: width
          description: The inventory item's width.
        title:
          type: string
          title: title
          description: The inventory item's title.
        description:
          type: string
          title: description
          description: The inventory item's description.
        thumbnail:
          type: string
          title: thumbnail
          description: The URL of the inventory item's thumbnail.
        metadata:
          type: object
          description: The inventory item's metadata, can hold custom key-value pairs.
        location_levels:
          type: array
          description: The inventory item's associated inventory levels.
          items:
            $ref: '#/components/schemas/AdminInventoryLevel'
    AdminInventoryItemResponse:
      type: object
      description: The inventory item's details.
      x-schemaName: AdminInventoryItemResponse
      required:
        - inventory_item
      properties:
        inventory_item:
          $ref: '#/components/schemas/AdminInventoryItem'
    AdminInventoryLevel:
      type: object
      description: The inventory level's details.
      x-schemaName: AdminInventoryLevel
      required:
        - id
        - created_at
        - updated_at
        - deleted_at
        - inventory_item_id
        - location_id
        - stocked_quantity
        - raw_stocked_quantity
        - reserved_quantity
        - raw_reserved_quantity
        - incoming_quantity
        - raw_incoming_quantity
        - metadata
        - available_quantity
      properties:
        id:
          type: string
          title: id
          description: The inventory level's ID.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The ID of the inventory item this level belongs to.
        location_id:
          type: string
          title: location_id
          description: The ID of the stock location this level belongs to.
        stocked_quantity:
          type: number
          title: stocked_quantity
          description: The quantity of the associated inventory item stocked in the associated stock location.
        reserved_quantity:
          type: number
          title: reserved_quantity
          description: The reserved quantity of the associated inventory item stocked in the associated stock location.
        incoming_quantity:
          type: number
          title: incoming_quantity
          description: The incoming quantity of the associated inventory item stocked in the associated stock location.
        metadata:
          type: object
          description: The location level's metadata, can hold custom key-value pairs.
        inventory_item:
          type: object
        available_quantity:
          type: number
          title: available_quantity
          description: The quantity available for order of the associated inventory item in the associated stock location.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the inventory level was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the inventory level was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the inventory level was deleted.
    AdminInvite:
      type: object
      description: The invite's details.
      x-schemaName: AdminInvite
      required:
        - id
        - email
        - accepted
        - token
      properties:
        id:
          type: string
          title: id
          description: The invite's ID.
        email:
          type: string
          title: email
          description: The invite's email.
          format: email
        accepted:
          type: boolean
          title: accepted
          description: Whether the invite has been accepted.
        token:
          type: string
          title: token
          description: The invite's token.
        expires_at:
          type: string
          title: expires_at
          description: The invite's expiry date.
          format: date-time
        metadata:
          type: object
          description: The invite's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the invite was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the invite was updated.
    AdminInviteResponse:
      type: object
      description: The invite's details.
      x-schemaName: AdminInviteResponse
      required:
        - invite
      properties:
        invite:
          $ref: '#/components/schemas/AdminInvite'
    AdminLinkPriceListProducts:
      type: object
      description: The products removal details.
      properties:
        remove:
          type: array
          description: The products to remove from the price list.
          items:
            type: string
            title: remove
            description: The ID of a product.
      x-schemaName: AdminLinkPriceListProducts
    AdminNotification:
      type: object
      description: The notification's details.
      x-schemaName: AdminNotification
      required:
        - id
        - to
        - channel
        - template
        - provider_id
        - created_at
      properties:
        id:
          type: string
          title: id
          description: The notification's ID.
        to:
          type: string
          title: to
          description: Where to send the notification to. For example, if `channel` is `email`, this can be an email number.
        channel:
          type: string
          title: channel
          description: Through which channel is the notification sent through.
          example: email
        template:
          type: string
          title: template
          description: The ID of the template in a third-party service used as the notification's shape.
        data:
          type: object
          description: Data payload to send with the notification.
        trigger_type:
          type: string
          title: trigger_type
          description: What triggered this notification.
          example: order.created
        resource_id:
          type: string
          title: resource_id
          description: The ID of the associated resource. For example, if the notification was triggered because an order was created, this would be the ID of the order.
        resource_type:
          type: string
          title: resource_type
          description: The type of the resource that triggered the notification.
          example: order
        receiver_id:
          type: string
          title: receiver_id
          description: The ID of the user or customer that's receiving this notification.
        original_notification_id:
          type: string
          title: original_notification_id
          description: The ID of the original notification, if this notification is resent.
        external_id:
          type: string
          title: external_id
          description: The ID of the notification in an external or third-party system.
        provider_id:
          type: string
          title: provider_id
          description: The ID of the provider used to send the notification.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the notification was created.
    AdminNotificationListResponse:
      type: object
      description: The paginated list of notifications.
      x-schemaName: AdminNotificationListResponse
      required:
        - limit
        - offset
        - count
        - notifications
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total count of items.
        notifications:
          type: array
          description: The list of notifications.
          items:
            $ref: '#/components/schemas/AdminNotification'
    AdminNotificationResponse:
      type: object
      description: The notification's details.
      x-schemaName: AdminNotificationResponse
      required:
        - notification
      properties:
        notification:
          $ref: '#/components/schemas/AdminNotification'
    AdminOrder:
      type: object
      description: The order's details.
      x-schemaName: AdminOrder
      required:
        - payment_collections
        - id
        - version
        - region_id
        - customer_id
        - sales_channel_id
        - email
        - currency_code
        - items
        - shipping_methods
        - payment_status
        - fulfillment_status
        - summary
        - metadata
        - created_at
        - updated_at
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        payment_collections:
          type: array
          description: The order's payment collections.
          items:
            $ref: '#/components/schemas/AdminPaymentCollection'
        fulfillments:
          type: array
          description: The order's fulfillments.
          items:
            $ref: '#/components/schemas/BaseOrderFulfillment'
        sales_channel:
          $ref: '#/components/schemas/AdminSalesChannel'
        customer:
          $ref: '#/components/schemas/AdminCustomer'
        shipping_address:
          $ref: '#/components/schemas/AdminOrderAddress'
        billing_address:
          $ref: '#/components/schemas/AdminOrderAddress'
        id:
          type: string
          title: id
          description: The order's ID.
        version:
          type: number
          title: version
          description: The order's version.
        region_id:
          type: string
          title: region_id
          description: The ID of the region associated with the order.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer that placed the order.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The ID of the sales channel the order is placed in.
        email:
          type: string
          title: email
          description: The email of the customer that placed the order.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The order's currency code.
        display_id:
          type: number
          title: display_id
          description: The order's display ID.
        items:
          type: array
          description: The order's items.
          items:
            $ref: '#/components/schemas/BaseOrderLineItem'
        shipping_methods:
          type: array
          description: The order's shipping methods.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethod'
        payment_status:
          type: string
          description: The order's payment status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
            - captured
            - partially_captured
            - partially_refunded
            - refunded
            - requires_action
        fulfillment_status:
          type: string
          description: The order's fulfillment status.
          enum:
            - canceled
            - not_fulfilled
            - partially_fulfilled
            - fulfilled
            - partially_shipped
            - shipped
            - partially_delivered
            - delivered
        transactions:
          type: array
          description: The order's transactions.
          items:
            $ref: '#/components/schemas/BaseOrderTransaction'
        summary:
          $ref: '#/components/schemas/BaseOrderSummary'
        metadata:
          type: object
          description: The order's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the order was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the order was updated.
        original_item_total:
          type: number
          title: original_item_total
          description: The total of the order's items including taxes, excluding promotions.
        original_item_subtotal:
          type: number
          title: original_item_subtotal
          description: The total of the order's items excluding taxes, including promotions.
        original_item_tax_total:
          type: number
          title: original_item_tax_total
          description: The tax total of the order's items excluding promotions.
        item_total:
          type: number
          title: item_total
          description: The total of the order's items including taxes and promotions.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The total of the order's items excluding taxes, including promotions.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The tax total of the order's items including promotions.
        original_total:
          type: number
          title: original_total
          description: The order's total excluding promotions, including taxes.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The order's total excluding taxes, including promotions.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The order's tax total, excluding promotions.
        total:
          type: number
          title: total
          description: The order's total including taxes and promotions.
        subtotal:
          type: number
          title: subtotal
          description: The order's total excluding taxes, including promotions.
        tax_total:
          type: number
          title: tax_total
          description: The order's tax total including promotions.
        discount_total:
          type: number
          title: discount_total
          description: The order's discount or promotions total.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The tax total of order's discount or promotion.
        gift_card_total:
          type: number
          title: gift_card_total
          description: The order's gift card total.
        gift_card_tax_total:
          type: number
          title: gift_card_tax_total
          description: The tax total of the order's gift card.
        shipping_total:
          type: number
          title: shipping_total
          description: The order's shipping total including taxes and promotions.
        shipping_subtotal:
          type: number
          title: shipping_subtotal
          description: The order's shipping total excluding taxes, including promotions.
        shipping_tax_total:
          type: number
          title: shipping_tax_total
          description: The tax total of the order's shipping.
        original_shipping_total:
          type: number
          title: original_shipping_total
          description: The order's shipping total including taxes, excluding promotions.
        original_shipping_subtotal:
          type: number
          title: original_shipping_subtotal
          description: The order's shipping total excluding taxes, including promotions.
        original_shipping_tax_total:
          type: number
          title: original_shipping_tax_total
          description: The tax total of the order's shipping excluding promotions.
    AdminOrderAddress:
      type: object
      description: An order address.
      x-schemaName: AdminOrderAddress
      required:
        - id
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer this address belongs to.
        first_name:
          type: string
          title: first_name
          description: The address's first name.
        last_name:
          type: string
          title: last_name
          description: The address's last name.
        phone:
          type: string
          title: phone
          description: The address's phone.
        company:
          type: string
          title: company
          description: The address's company.
        address_1:
          type: string
          title: address_1
          description: The address's first line.
        address_2:
          type: string
          title: address_2
          description: The address's second line.
        city:
          type: string
          title: city
          description: The address's city.
        country_code:
          type: string
          title: country_code
          description: The address's country code.
          example: us
        country:
          $ref: '#/components/schemas/AdminRegionCountry'
        province:
          type: string
          title: province
          description: The address's province.
        postal_code:
          type: string
          title: postal_code
          description: The address's postal code.
        metadata:
          type: object
          description: The address's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the address was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the address was updated.
    AdminOrderChangesResponse:
      type: object
      description: The details of an order's changes.
      x-schemaName: AdminOrderChangesResponse
      required:
        - order_changes
      properties:
        order_changes:
          type: array
          description: An order's changes.
          items:
            $ref: '#/components/schemas/BaseOrderChange'
    AdminOrderEditPreviewResponse:
      type: object
      description: The preview of an order edit.
      x-schemaName: AdminOrderEditPreviewResponse
      required:
        - order_preview
      properties:
        order_preview:
          $ref: '#/components/schemas/OrderPreview'
    AdminOrderEditResponse:
      type: object
      description: An order edit's details.
      x-schemaName: AdminOrderEditResponse
      required:
        - order_change
      properties:
        order_change:
          $ref: '#/components/schemas/OrderChange'
    AdminOrderPreview:
      type: object
      description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
      x-schemaName: AdminOrderPreview
      required:
        - return_requested_total
        - order_change
        - currency_code
        - version
        - id
        - region_id
        - customer_id
        - sales_channel_id
        - email
        - payment_collections
        - payment_status
        - fulfillment_status
        - summary
        - metadata
        - created_at
        - updated_at
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        return_requested_total:
          type: number
          title: return_requested_total
          description: The total of the requested return.
        order_change:
          $ref: '#/components/schemas/BaseOrderChange'
        items:
          type: array
          description: The order's items.
          items:
            allOf:
              - type: object
                description: An order's item.
                x-schemaName: BaseOrderLineItem
                required:
                  - id
                  - title
                  - subtitle
                  - thumbnail
                  - variant_id
                  - product_id
                  - product_title
                  - product_description
                  - product_subtitle
                  - product_type
                  - product_collection
                  - product_handle
                  - variant_sku
                  - variant_barcode
                  - variant_title
                  - variant_option_values
                  - requires_shipping
                  - is_discountable
                  - is_tax_inclusive
                  - unit_price
                  - quantity
                  - detail
                  - created_at
                  - updated_at
                  - metadata
                  - original_total
                  - original_subtotal
                  - original_tax_total
                  - item_total
                  - item_subtotal
                  - item_tax_total
                  - total
                  - subtotal
                  - tax_total
                  - discount_total
                  - discount_tax_total
                  - refundable_total
                  - refundable_total_per_unit
                properties:
                  id:
                    type: string
                    title: id
                    description: The item's ID.
                  title:
                    type: string
                    title: title
                    description: The item's title.
                  subtitle:
                    type: string
                    title: subtitle
                    description: The item's subtitle.
                  thumbnail:
                    type: string
                    title: thumbnail
                    description: The URL of the item's thumbnail.
                  variant:
                    $ref: '#/components/schemas/BaseProductVariant'
                  variant_id:
                    type: string
                    title: variant_id
                    description: The ID of the associated variant.
                  product:
                    $ref: '#/components/schemas/BaseProduct'
                  product_id:
                    type: string
                    title: product_id
                    description: The ID of the associated product.
                  product_title:
                    type: string
                    title: product_title
                    description: The title of the item's product.
                  product_description:
                    type: string
                    title: product_description
                    description: The description of the item's product.
                  product_subtitle:
                    type: string
                    title: product_subtitle
                    description: The subtitle of the item's product.
                  product_type:
                    type: string
                    title: product_type
                    description: The ID of type of the item's product.
                  product_collection:
                    type: string
                    title: product_collection
                    description: The ID of collection of the item's product.
                  product_handle:
                    type: string
                    title: product_handle
                    description: The handle of the item's product.
                  variant_sku:
                    type: string
                    title: variant_sku
                    description: The SKU of the item's variant.
                  variant_barcode:
                    type: string
                    title: variant_barcode
                    description: The barcode of the item's variant.
                  variant_title:
                    type: string
                    title: variant_title
                    description: The title of the item's variant.
                  variant_option_values:
                    type: object
                    description: The option values of the item's variant as key-value pairs. The key is the title of an option, and the value is the option's value.
                  requires_shipping:
                    type: boolean
                    title: requires_shipping
                    description: Whether the item requires shipping.
                  is_discountable:
                    type: boolean
                    title: is_discountable
                    description: Whether the item is discountable.
                  is_tax_inclusive:
                    type: boolean
                    title: is_tax_inclusive
                    description: Whether the item's price includes taxes.
                  compare_at_unit_price:
                    type: number
                    title: The original price of the item before a promotion or sale.
                    description: The
                  unit_price:
                    type: number
                    title: unit_price
                    description: The item's unit price.
                  quantity:
                    type: number
                    title: quantity
                    description: The item's quantity.
                  tax_lines:
                    type: array
                    description: The item's tax lines.
                    items:
                      $ref: '#/components/schemas/BaseOrderLineItemTaxLine'
                  adjustments:
                    type: array
                    description: The item's adjustments.
                    items:
                      $ref: '#/components/schemas/BaseOrderLineItemAdjustment'
                  detail:
                    $ref: '#/components/schemas/BaseOrderItemDetail'
                  created_at:
                    type: string
                    format: date-time
                    title: created_at
                    description: The date the item was created.
                  updated_at:
                    type: string
                    format: date-time
                    title: updated_at
                    description: The date the item was updated.
                  metadata:
                    type: object
                    description: The item's metadata, can hold custom key-value pairs.
                  original_total:
                    type: number
                    title: original_total
                    description: The item's total including taxes, excluding promotions.
                  original_subtotal:
                    type: number
                    title: original_subtotal
                    description: The item's total excluding taxes, including promotions.
                  original_tax_total:
                    type: number
                    title: original_tax_total
                    description: The tax total of the item excluding promotions.
                  item_total:
                    type: number
                    title: item_total
                    description: The item's total for a single unit including taxes and promotions.
                  item_subtotal:
                    type: number
                    title: item_subtotal
                    description: The item's total for a single unit excluding taxes, including promotions.
                  item_tax_total:
                    type: number
                    title: item_tax_total
                    description: The tax total for a single unit of the item including promotions.
                  total:
                    type: number
                    title: total
                    description: The item's total including taxes and promotions.
                  subtotal:
                    type: number
                    title: subtotal
                    description: The item's total excluding taxes, including promotions.
                  tax_total:
                    type: number
                    title: tax_total
                    description: The tax total of the item including promotions.
                  discount_total:
                    type: number
                    title: discount_total
                    description: The total of the item's discount / promotion.
                  discount_tax_total:
                    type: number
                    title: discount_tax_total
                    description: The tax total of the item's discount / promotion
                  refundable_total:
                    type: number
                    title: refundable_total
                    description: The total refundable amount of the item's total.
                  refundable_total_per_unit:
                    type: number
                    title: refundable_total_per_unit
                    description: The total refundable amount of the item's total for a single unit.
              - type: object
                description: An order's item.
                properties:
                  actions:
                    type: array
                    description: The actions applied on an item.
                    items:
                      type: object
                      description: The action's details.
                      x-schemaName: BaseOrderChangeAction
        shipping_methods:
          type: array
          description: The order's shipping methods.
          items:
            allOf:
              - type: object
                description: The shipping method's details.
                x-schemaName: BaseOrderShippingMethod
                required:
                  - id
                  - order_id
                  - name
                  - amount
                  - is_tax_inclusive
                  - shipping_option_id
                  - data
                  - metadata
                  - original_total
                  - original_subtotal
                  - original_tax_total
                  - total
                  - subtotal
                  - tax_total
                  - discount_total
                  - discount_tax_total
                  - created_at
                  - updated_at
                properties:
                  id:
                    type: string
                    title: id
                    description: The shipping method's ID.
                  order_id:
                    type: string
                    title: order_id
                    description: The ID of the order this shipping method belongs to.
                  name:
                    type: string
                    title: name
                    description: The shipping method's name.
                  description:
                    type: string
                    title: description
                    description: The shipping method's description.
                  amount:
                    type: number
                    title: amount
                    description: The shipping method's amount.
                  is_tax_inclusive:
                    type: boolean
                    title: is_tax_inclusive
                    description: Whether the shipping method's amount is tax inclusive.
                  shipping_option_id:
                    type: string
                    title: shipping_option_id
                    description: The ID of the shipping option this method was created from.
                  data:
                    type: object
                    description: The data relevant for the fulfillment provider to process this shipment.
                    externalDocs:
                      url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property
                  metadata:
                    type: object
                    description: The shipping method's metadata, can hold custom key-value pairs.
                  tax_lines:
                    type: array
                    description: The shipping method's tax lines.
                    items:
                      $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine'
                  adjustments:
                    type: array
                    description: The shipping method's adjustments.
                    items:
                      $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment'
                  original_total:
                    oneOf:
                      - type: string
                        title: original_total
                        description: The shipping method's total including taxes, excluding promotions.
                      - type: number
                        title: original_total
                        description: The shipping method's total including taxes, excluding promotions.
                  original_subtotal:
                    oneOf:
                      - type: string
                        title: original_subtotal
                        description: The shipping method's total excluding taxes, including promotions.
                      - type: number
                        title: original_subtotal
                        description: The shipping method's total excluding taxes, including promotions.
                  original_tax_total:
                    oneOf:
                      - type: string
                        title: original_tax_total
                        description: The tax total of the shipping method excluding promotions.
                      - type: number
                        title: original_tax_total
                        description: The tax total of the shipping method excluding promotions.
                  total:
                    oneOf:
                      - type: string
                        title: total
                        description: The shipping method's total including taxes and promotions.
                      - type: number
                        title: total
                        description: The shipping method's total including taxes and promotions.
                  subtotal:
                    oneOf:
                      - type: string
                        title: subtotal
                        description: The shipping method's total excluding taxes, including promotions.
                      - type: number
                        title: subtotal
                        description: The shipping method's total excluding taxes, including promotions.
                  tax_total:
                    oneOf:
                      - type: string
                        title: tax_total
                        description: The tax total of the shipping method including promotions.
                      - type: number
                        title: tax_total
                        description: The tax total of the shipping method including promotions.
                  discount_total:
                    oneOf:
                      - type: string
                        title: discount_total
                        description: The total of the shipping method's promotion.
                      - type: number
                        title: discount_total
                        description: The total of the shipping method's promotion.
                  discount_tax_total:
                    oneOf:
                      - type: string
                        title: discount_tax_total
                        description: The tax total of the shipping method's promotion.
                      - type: number
                        title: discount_tax_total
                        description: The shipping method's discount tax total.
                  created_at:
                    type: string
                    format: date-time
                    title: created_at
                    description: The date the shipping method was created.
                  updated_at:
                    type: string
                    format: date-time
                    title: updated_at
                    description: The date the shipping method was updated.
              - type: object
                description: The shipping method's details.
                properties:
                  actions:
                    type: array
                    description: The actions applied on the shipping method.
                    items:
                      type: object
                      description: The action's details.
                      x-schemaName: BaseOrderChangeAction
        currency_code:
          type: string
          title: currency_code
          description: The order's currency code.
        version:
          type: number
          title: version
          description: The order's version when this preview is applied.
        id:
          type: string
          title: id
          description: The order's ID.
        region_id:
          type: string
          title: region_id
          description: The ID of the order's associated region.
        customer_id:
          type: string
          title: customer_id
          description: The ID of the customer that placed the order.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The ID of the sales channel that the order was placed in.
        email:
          type: string
          title: email
          description: The email of the customer that placed the order.
          format: email
        display_id:
          type: number
          title: display_id
          description: The order's display ID.
        shipping_address:
          $ref: '#/components/schemas/AdminOrderAddress'
        billing_address:
          $ref: '#/components/schemas/AdminOrderAddress'
        payment_collections:
          type: array
          description: The order's payment collections.
          items:
            $ref: '#/components/schemas/AdminPaymentCollection'
        payment_status:
          type: string
          description: The order's payment status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
            - captured
            - partially_captured
            - partially_refunded
            - refunded
            - requires_action
        fulfillments:
          type: array
          description: The order's fulfillments.
          items:
            $ref: '#/components/schemas/BaseOrderFulfillment'
        fulfillment_status:
          type: string
          description: The order's fulfillment status.
          enum:
            - canceled
            - not_fulfilled
            - partially_fulfilled
            - fulfilled
            - partially_shipped
            - shipped
            - partially_delivered
            - delivered
        transactions:
          type: array
          description: The order's transactions.
          items:
            $ref: '#/components/schemas/BaseOrderTransaction'
        summary:
          $ref: '#/components/schemas/BaseOrderSummary'
        metadata:
          type: object
          description: The order's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the order was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the order was updated.
        original_item_total:
          type: number
          title: original_item_total
          description: The total of the order's items including taxes, excluding promotions.
        original_item_subtotal:
          type: number
          title: original_item_subtotal
          description: The total of the order's items excluding taxes, including promotions.
        original_item_tax_total:
          type: number
          title: original_item_tax_total
          description: The tax total of the order's items excluding promotions.
        item_total:
          type: number
          title: item_total
          description: The total of the order's items including taxes and promotions.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The total of the order's items excluding taxes, including promotions.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The tax total of the order's items including promotions.
        original_total:
          type: number
          title: original_total
          description: The order's total excluding promotions, including taxes.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The order's total excluding taxes, including promotions.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The order's tax total, excluding promotions.
        total:
          type: number
          title: total
          description: The order's total including taxes and promotions.
        subtotal:
          type: number
          title: subtotal
          description: The order's total excluding taxes, including promotions.
        tax_total:
          type: number
          title: tax_total
          description: The order's tax total including promotions.
        discount_total:
          type: number
          title: discount_total
          description: The order's discount or promotions total.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The tax total of order's discount or promotion.
        gift_card_total:
          type: number
          title: gift_card_total
          description: The order's gift card total.
        gift_card_tax_total:
          type: number
          title: gift_card_tax_total
          description: The tax total of the order's gift card.
        shipping_total:
          type: number
          title: shipping_total
          description: The order's shipping total including taxes and promotions.
        shipping_subtotal:
          type: number
          title: shipping_subtotal
          description: The order's shipping total excluding taxes, including promotions.
        shipping_tax_total:
          type: number
          title: shipping_tax_total
          description: The tax total of the order's shipping.
        original_shipping_total:
          type: number
          title: original_shipping_total
          description: The order's shipping total including taxes, excluding promotions.
        original_shipping_subtotal:
          type: number
          title: original_shipping_subtotal
          description: The order's shipping total excluding taxes, including promotions.
        original_shipping_tax_total:
          type: number
          title: original_shipping_tax_total
          description: The tax total of the order's shipping excluding promotions.
        customer:
          $ref: '#/components/schemas/AdminCustomer'
        sales_channel:
          $ref: '#/components/schemas/AdminSalesChannel'
    AdminOrderPreviewResponse:
      type: object
      description: The preview of an order.
      x-schemaName: AdminOrderPreviewResponse
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/AdminOrderPreview'
    AdminOrderResponse:
      type: object
      description: An order's details.
      x-schemaName: AdminOrderResponse
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/AdminOrder'
    AdminOrderReturnResponse:
      type: object
      description: The order return details.
      x-schemaName: AdminOrderReturnResponse
      required:
        - order
        - return
      properties:
        order:
          $ref: '#/components/schemas/Order'
        return:
          $ref: '#/components/schemas/AdminReturn'
    AdminPayment:
      type: object
      description: The payment's details.
      x-schemaName: AdminPayment
      required:
        - id
        - amount
        - currency_code
        - provider_id
      properties:
        id:
          type: string
          title: id
          description: The payment's ID.
        amount:
          type: number
          title: amount
          description: The payment's amount.
        authorized_amount:
          type: number
          title: authorized_amount
          description: The amount authorized of the payment.
        currency_code:
          type: string
          title: currency_code
          description: The payment's currency code.
        provider_id:
          type: string
          title: provider_id
          description: The ID of the payment provider used to process this payment.
        cart_id:
          type: string
          title: cart_id
          description: The ID of the associated cart.
        order_id:
          type: string
          title: order_id
          description: The ID of the associated order.
        order_edit_id:
          type: string
          title: order_edit_id
          description: The ID of the associated order edit.
        customer_id:
          type: string
          title: customer_id
          description: ID of the associated customer.
        data:
          type: object
          description: The payment's data, useful for processing by the payment provider.
          externalDocs:
            url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the payment was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the payment was updated.
        captured_at:
          type: string
          format: date-time
          title: captured_at
          description: The date the payment was captured.
        canceled_at:
          type: string
          format: date-time
          title: canceled_at
          description: The date the payment was canceled.
        captured_amount:
          type: number
          title: captured_amount
          description: The captured amount of the payment.
        refunded_amount:
          type: number
          title: captured_amount
          description: The refunded amount of the payment.
        captures:
          type: array
          description: The details of payment captures.
          items:
            $ref: '#/components/schemas/BaseCapture'
        refunds:
          type: array
          description: The details of payment refunds.
          items:
            $ref: '#/components/schemas/BaseRefund'
        payment_collection:
          $ref: '#/components/schemas/BasePaymentCollection'
        payment_session:
          $ref: '#/components/schemas/BasePaymentSession'
    AdminPaymentCollection:
      type: object
      description: The payment collection's details.
      x-schemaName: AdminPaymentCollection
      required:
        - id
        - currency_code
        - region_id
        - amount
        - status
        - payment_providers
      properties:
        id:
          type: string
          title: id
          description: The payment collection's ID.
        currency_code:
          type: string
          title: currency_code
          description: The payment collection's currency code.
        region_id:
          type: string
          title: region_id
          description: The ID of the region this payment collection is associated with.
        amount:
          type: number
          title: amount
          description: The total amount to be paid.
        authorized_amount:
          type: number
          title: authorized_amount
          description: The total authorized amount of the collection's payments.
        captured_amount:
          type: number
          title: captured_amount
          description: The total captured amount of the collection's payments.
        refunded_amount:
          type: number
          title: refunded_amount
          description: The total refunded amount of the collection's payments.
        completed_at:
          type: string
          format: date-time
          title: completed_at
          description: The date the payment collection was completed.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the payment collection was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the payment collection was updated.
        metadata:
          type: object
          description: The payment collection's metadata, can hold custom key-value pairs.
        status:
          type: string
          description: The payment collection's status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
        payment_providers:
          type: array
          description: The payment provider used to process the collection's payments and sessions.
          items:
            $ref: '#/components/schemas/BasePaymentProvider'
        payment_sessions:
          type: array
          description: The payment collection's payment sessions.
          items:
            $ref: '#/components/schemas/BasePaymentSession'
        payments:
          type: array
          description: The payment collection's payments.
          items:
            $ref: '#/components/schemas/BasePayment'
    AdminPaymentCollectionResponse:
      type: object
      description: The payment collection's details.
      x-schemaName: AdminPaymentCollectionResponse
      required:
        - payment_collection
      properties:
        payment_collection:
          $ref: '#/components/schemas/AdminPaymentCollection'
    AdminPaymentProvider:
      type: object
      description: The payment provider's details.
      x-schemaName: AdminPaymentProvider
      required:
        - is_enabled
        - id
      properties:
        id:
          type: string
          title: id
          description: The payment provider's ID.
        is_enabled:
          type: boolean
          title: is_enabled
          description: Whether the payment provider is enabled.
    AdminPaymentResponse:
      type: object
      description: The payment's details.
      x-schemaName: AdminPaymentResponse
      required:
        - payment
      properties:
        payment:
          $ref: '#/components/schemas/AdminPayment'
    AdminPostCancelClaimReqSchema:
      type: object
      description: The details of canceling a claim.
      x-schemaName: AdminPostCancelClaimReqSchema
      properties:
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send the customer a notification about the claim's cancelation.
    AdminPostCancelExchangeReqSchema:
      type: object
      description: The details of canceling an exchange.
      x-schemaName: AdminPostCancelExchangeReqSchema
      properties:
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send a notification to the customer about the exchange's cancelation.
    AdminPostCancelReturnReqSchema:
      type: object
      description: The details of canceling a return.
      x-schemaName: AdminPostCancelReturnReqSchema
      properties:
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send the customer a notification about the return's cancelation.
    AdminPostClaimItemsReqSchema:
      type: object
      description: The details of the order items to add to the claim.
      x-schemaName: AdminPostClaimItemsReqSchema
      properties:
        items:
          type: array
          description: The item's details.
          items:
            type: object
            description: An item's details.
            required:
              - id
              - quantity
            properties:
              id:
                type: string
                title: id
                description: The ID of the order's item.
              quantity:
                type: number
                title: quantity
                description: The quantity of the order's item to add to the claim.
              reason:
                type: string
                description: The reason the item is claimed.
                enum:
                  - missing_item
                  - wrong_item
                  - production_failure
                  - other
              description:
                type: string
                title: description
                description: The item's description.
              internal_note:
                type: string
                title: internal_note
                description: A note that's only viewed by admin users.
    AdminPostClaimsAddItemsReqSchema:
      type: object
      description: The details of the outbound items to add to the claim.
      x-schemaName: AdminPostClaimsAddItemsReqSchema
      properties:
        items:
          type: array
          description: The outbound item's details.
          items:
            type: object
            description: An item's details.
            required:
              - variant_id
              - quantity
            properties:
              variant_id:
                type: string
                title: variant_id
                description: The ID of the associated product variant.
              quantity:
                type: number
                title: quantity
                description: The quantity to send to the customer.
              unit_price:
                type: number
                title: unit_price
                description: The item's unit price.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
              metadata:
                type: object
                description: The item's metadata, can hold custom key-value pairs.
    AdminPostClaimsItemsActionReqSchema:
      type: object
      description: The details to update in the item.
      x-schemaName: AdminPostClaimsItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        reason_id:
          type: string
          title: reason_id
          description: The ID of the return reason associated with the item.
        internal_note:
          type: string
          title: internal_note
          description: A note that's only viewed by admin users.
    AdminPostClaimsShippingActionReqSchema:
      type: object
      description: The details to update in the shipping method.
      x-schemaName: AdminPostClaimsShippingActionReqSchema
      properties:
        custom_amount:
          type: number
          title: custom_amount
          description: The shipping method's custom amount.
        internal_note:
          type: string
          title: internal_note
          description: A note only viewed by admin users.
        metadata:
          type: object
          description: The claim's metadata, can hold custom key-value pairs.
    AdminPostClaimsShippingReqSchema:
      type: object
      description: The details of the shipping method used to ship outbound items.
      x-schemaName: AdminPostClaimsShippingReqSchema
      required:
        - shipping_option_id
      properties:
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the associated shipping option.
        custom_amount:
          type: number
          title: custom_amount
          description: Set a custom price for the shipping method.
        description:
          type: string
          title: description
          description: The shipping method's description.
        internal_note:
          type: string
          title: internal_note
          description: A note only viewed by admin users.
        metadata:
          type: object
          description: The claim's metadata, can hold custom key-value pairs.
    AdminPostExchangesAddItemsReqSchema:
      type: object
      description: The details of outbound items.
      x-schemaName: AdminPostExchangesAddItemsReqSchema
      properties:
        items:
          type: array
          description: The details of outbound items.
          items:
            type: object
            description: An item's details.
            required:
              - variant_id
              - quantity
            properties:
              variant_id:
                type: string
                title: variant_id
                description: The ID of the associated product variant.
              quantity:
                type: number
                title: quantity
                description: The item's quantity.
              unit_price:
                type: number
                title: unit_price
                description: The item's unit price.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
              allow_backorder:
                type: boolean
                title: allow_backorder
                description: Whether the item can be added even if it's not in stock.
              metadata:
                type: object
                description: The item's metadata, can hold custom key-value pairs.
    AdminPostExchangesItemsActionReqSchema:
      type: object
      description: The details to update in an outbound item.
      x-schemaName: AdminPostExchangesItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note only viewed by admin users.
    AdminPostExchangesRequestItemsReturnActionReqSchema:
      type: object
      description: The details to update in an inbound (returned) item.
      x-schemaName: AdminPostExchangesRequestItemsReturnActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        reason_id:
          type: string
          title: reason_id
          description: The ID of the associated return reason.
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
    AdminPostExchangesReturnRequestItemsReqSchema:
      type: object
      description: The details of the inbound (return) items.
      x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
      properties:
        items:
          type: array
          description: The details of the inbound (return) items.
          items:
            type: object
            description: An item's details.
            required:
              - id
              - quantity
            properties:
              id:
                type: string
                title: id
                description: The ID of the order's item.
              quantity:
                type: number
                title: quantity
                description: The item's quantity.
              description:
                type: string
                title: description
                description: The item's description.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
              reason_id:
                type: string
                title: reason_id
                description: The ID of the return reason to associate with the item.
              metadata:
                type: object
                description: The item's metadata, can hold custom key-value pairs.
    AdminPostExchangesShippingActionReqSchema:
      type: object
      description: The details of the shipping method to update.
      x-schemaName: AdminPostExchangesShippingActionReqSchema
      properties:
        custom_amount:
          type: number
          title: custom_amount
          description: The shipping method's custom amount.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed by admin users only.
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
    AdminPostExchangesShippingReqSchema:
      type: object
      description: The outbound shipping method's details.
      x-schemaName: AdminPostExchangesShippingReqSchema
      required:
        - shipping_option_id
      properties:
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the associated shipping option.
        custom_amount:
          type: number
          title: custom_amount
          description: Set a custom amount for the shipping method.
        description:
          type: string
          title: description
          description: The shipping method's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed by admin users only.
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
    AdminPostOrderClaimsReqSchema:
      type: object
      description: The claim's details.
      x-schemaName: AdminPostOrderClaimsReqSchema
      required:
        - type
        - order_id
      properties:
        type:
          type: string
          description: The claim's type.
          enum:
            - refund
            - replace
        order_id:
          type: string
          title: order_id
          description: The ID of the order the claim is created for.
        description:
          type: string
          title: description
          description: The claim's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        reason_id:
          type: string
          title: reason_id
          description: The ID of the associated return reason.
        metadata:
          type: object
          description: The claim's metadata, can hold custom key-value pairs.
    AdminPostOrderEditsAddItemsReqSchema:
      type: object
      description: The details of items to be edited.
      x-schemaName: AdminPostOrderEditsAddItemsReqSchema
      properties:
        items:
          type: array
          description: The details of items to be edited.
          items:
            type: object
            description: An item's details.
            required:
              - variant_id
              - quantity
            properties:
              variant_id:
                type: string
                title: variant_id
                description: The ID of the associated product variant.
              quantity:
                type: number
                title: quantity
                description: The item's quantity.
              unit_price:
                type: number
                title: unit_price
                description: The item's unit price.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
              allow_backorder:
                type: boolean
                title: allow_backorder
                description: Whether the item can be added even if there's no available invenotory quantity of the variant.
              metadata:
                type: object
                description: The item's metadata, can hold custom key-value pairs.
    AdminPostOrderEditsItemsActionReqSchema:
      type: object
      description: The details to update in the item.
      x-schemaName: AdminPostOrderEditsItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
    AdminPostOrderEditsReqSchema:
      type: object
      description: The order edit's details.
      x-schemaName: AdminPostOrderEditsReqSchema
      required:
        - order_id
      properties:
        order_id:
          type: string
          title: order_id
          description: The ID of the order this edit is for.
        description:
          type: string
          title: description
          description: The order edit's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The order edit's metadata, can hold custom key-value pairs.
    AdminPostOrderEditsShippingActionReqSchema:
      type: object
      description: The shipping method's details.
      x-schemaName: AdminPostOrderEditsShippingActionReqSchema
      properties:
        custom_amount:
          type: number
          title: custom_amount
          description: Set a custom price for the shipping method.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The order edit's metadata, can hold custom key-value pairs.
    AdminPostOrderEditsShippingReqSchema:
      type: object
      description: The shipping method's details.
      x-schemaName: AdminPostOrderEditsShippingReqSchema
      required:
        - shipping_option_id
      properties:
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the associated shipping option.
        custom_amount:
          type: number
          title: custom_amount
          description: Set a custom price for the shipping method.
        description:
          type: string
          title: description
          description: The shipping method's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The shipping method's metadata, can hold custom key-value pairs.
    AdminPostOrderEditsUpdateItemQuantityReqSchema:
      type: object
      description: The order item's details to update.
      x-schemaName: AdminPostOrderEditsUpdateItemQuantityReqSchema
      required:
        - quantity
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
    AdminPostOrderExchangesReqSchema:
      type: object
      description: The exchange's details.
      x-schemaName: AdminPostOrderExchangesReqSchema
      required:
        - order_id
      properties:
        order_id:
          type: string
          title: order_id
          description: The ID of the order this exchange is created for.
        description:
          type: string
          title: description
          description: The exchange's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
    AdminPostReceiveReturnsReqSchema:
      type: object
      description: The return receival details.
      x-schemaName: AdminPostReceiveReturnsReqSchema
      properties:
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        description:
          type: string
          title: description
          description: The return's description.
        metadata:
          type: object
          description: The return's metadata, can hold custom key-value pairs.
    AdminPostReturnsConfirmRequestReqSchema:
      type: object
      description: The confirmation's details.
      x-schemaName: AdminPostReturnsConfirmRequestReqSchema
      properties:
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send the customer a notification about the confirmation.
    AdminPostReturnsDismissItemsActionReqSchema:
      type: object
      description: The details to update of the damaged item.
      x-schemaName: AdminPostReturnsDismissItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
    AdminPostReturnsReceiveItemsActionReqSchema:
      type: object
      description: The details of the received item.
      x-schemaName: AdminPostReturnsReceiveItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
    AdminPostReturnsReceiveItemsReqSchema:
      type: object
      description: The items details.
      x-schemaName: AdminPostReturnsReceiveItemsReqSchema
      properties:
        items:
          type: array
          description: The items details.
          items:
            type: object
            description: An item's details.
            required:
              - id
              - quantity
            properties:
              id:
                type: string
                title: id
                description: The ID of the item in the order.
              quantity:
                type: number
                title: quantity
                description: The item's quantity.
              description:
                type: string
                title: description
                description: The item's description.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
    AdminPostReturnsReqSchema:
      type: object
      description: The return's details.
      x-schemaName: AdminPostReturnsReqSchema
      required:
        - order_id
      properties:
        order_id:
          type: string
          title: order_id
          description: The ID of the order the return belongs to.
        location_id:
          type: string
          title: location_id
          description: The ID of the location the items are returned to.
        description:
          type: string
          title: description
          description: The return's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        no_notification:
          type: boolean
          title: no_notification
          description: Whether to send the customer a notification about the created return.
        metadata:
          type: object
          description: The return's metadata, can hold custom key-value pairs.
    AdminPostReturnsRequestItemsActionReqSchema:
      type: object
      description: The details to update in the item.
      x-schemaName: AdminPostReturnsRequestItemsActionReqSchema
      properties:
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        reason_id:
          type: string
          title: reason_id
          description: The ID of the associated return reason.
        metadata:
          type: object
          description: The claim's metadata, can hold custom key-value pairs.
    AdminPostReturnsRequestItemsReqSchema:
      type: object
      description: The items' details.
      x-schemaName: AdminPostReturnsRequestItemsReqSchema
      properties:
        items:
          type: array
          description: The items' details.
          items:
            type: object
            description: An item's details.
            required:
              - id
              - quantity
            properties:
              id:
                type: string
                title: id
                description: The item's ID.
              quantity:
                type: number
                title: quantity
                description: The item's quantity.
              description:
                type: string
                title: description
                description: The item's description.
              internal_note:
                type: string
                title: internal_note
                description: A note viewed only by admin users.
              reason_id:
                type: string
                title: reason_id
                description: The ID of the associated return reason.
              metadata:
                type: object
                description: The item's metadata, can hold custom key-value pairs.
    AdminPostReturnsReturnReqSchema:
      type: object
      description: The return's details.
      x-schemaName: AdminPostReturnsReturnReqSchema
      properties:
        location_id:
          type: string
          title: location_id
          description: The ID of the location to return items to.
        no_notification:
          type: boolean
          title: no_notification
          description: Whether the customer should receive notifications about updates to the return.
        metadata:
          type: object
          description: The return's metadata, can hold custom key-value pairs.
    AdminPostReturnsShippingActionReqSchema:
      type: object
      description: The shipping method's details.
      x-schemaName: AdminPostReturnsShippingActionReqSchema
      properties:
        custom_amount:
          type: number
          title: custom_amount
          description: Set a custom price for the shipping method.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The return's metadata, can hold custom key-value pairs.
    AdminPostReturnsShippingReqSchema:
      type: object
      description: The shipping method's details.
      x-schemaName: AdminPostReturnsShippingReqSchema
      required:
        - shipping_option_id
      properties:
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The ID of the associated shipping option.
        custom_amount:
          type: number
          title: custom_amount
          description: Set the price of the shipping method.
        description:
          type: string
          title: description
          description: The shipping method's description.
        internal_note:
          type: string
          title: internal_note
          description: A note viewed only by admin users.
        metadata:
          type: object
          description: The exchange's metadata, can hold custom key-value pairs.
    AdminPrice:
      type: object
      description: The price's details.
      x-schemaName: AdminPrice
      required:
        - id
        - title
        - currency_code
        - amount
        - raw_amount
        - min_quantity
        - max_quantity
        - price_set_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The price's ID.
        title:
          type: string
          title: title
          description: The price's title.
        currency_code:
          type: string
          title: currency_code
          description: The price's currency code.
          example: usd
        amount:
          type: number
          title: amount
          description: The price's amount.
        raw_amount:
          type: object
          description: The price's raw amount.
        min_quantity:
          type: number
          title: min_quantity
          description: The minimum quantity that must be available in the cart for the price to be applied.
        max_quantity:
          type: number
          title: max_quantity
          description: The maximum quantity allowed to be available in the cart for the price to be applied.
        price_set_id:
          type: string
          title: price_set_id
          description: The ID of the associated price set.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price was deleted.
    AdminPriceList:
      type: object
      description: The price list's details.
      x-schemaName: AdminPriceList
      required:
        - id
        - title
        - description
        - rules
        - starts_at
        - ends_at
        - status
        - type
        - prices
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The price list's ID.
        title:
          type: string
          title: title
          description: The price list's title.
        description:
          type: string
          title: description
          description: The price list's description.
        rules:
          type: object
          description: The price list's rules.
        starts_at:
          type: string
          title: starts_at
          description: The date the price list starts.
        ends_at:
          type: string
          title: ends_at
          description: The date the price list ends.
        status:
          type: string
          description: The price list's status.
          enum:
            - draft
            - active
        type:
          type: string
          description: The price list's type.
          enum:
            - sale
            - override
        prices:
          type: array
          description: The price list's prices.
          items:
            $ref: '#/components/schemas/AdminPriceListPrice'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price list was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price list was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price list was deleted.
    AdminPriceListBatchResponse:
      type: object
      description: The details of the created, updated, and deleted prices in a price list.
      x-schemaName: AdminPriceListBatchResponse
      required:
        - created
        - updated
        - deleted
      properties:
        created:
          type: array
          description: The created prices.
          items:
            $ref: '#/components/schemas/AdminPrice'
        updated:
          type: array
          description: The updated prices.
          items:
            $ref: '#/components/schemas/AdminPrice'
        deleted:
          type: object
          description: The details of the deleted prices.
          required:
            - ids
            - object
            - deleted
          properties:
            ids:
              type: array
              description: The IDs of the deleted prices.
              items:
                type: string
                title: ids
                description: A price's ID.
            object:
              type: string
              title: object
              description: The name of the deleted object.
              default: price
            deleted:
              type: boolean
              title: deleted
              description: Whether the prices were deleted.
    AdminPriceListDeleteResponse:
      type: object
      description: The details of the deleted price list.
      x-schemaName: AdminPriceListDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The price list's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: price_list
        deleted:
          type: boolean
          title: deleted
          description: Whether the price list was deleted.
    AdminPriceListListResponse:
      type: object
      description: The paginated list of price lists.
      x-schemaName: AdminPriceListListResponse
      required:
        - limit
        - offset
        - count
        - price_lists
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total number of items.
        price_lists:
          type: array
          description: The list of price lists.
          items:
            $ref: '#/components/schemas/AdminPriceList'
    AdminPriceListPrice:
      type: object
      description: The details of a price list's price.
      x-schemaName: AdminPriceListPrice
      required:
        - variant_id
        - rules
        - id
        - title
        - currency_code
        - amount
        - raw_amount
        - min_quantity
        - max_quantity
        - price_set_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        variant_id:
          type: string
          title: variant_id
          description: The ID of the product variant this price list is for.
        rules:
          type: object
          description: The price's rules.
        id:
          type: string
          title: id
          description: The price's ID.
        title:
          type: string
          title: title
          description: The price's title.
        currency_code:
          type: string
          title: currency_code
          description: The price's currency code.
          example: usd
        amount:
          type: number
          title: amount
          description: The price's amount.
        raw_amount:
          type: object
          description: The price's raw amount.
        min_quantity:
          type: number
          title: min_quantity
          description: The minimum quantity that must be available in the cart for the price to be applied.
        max_quantity:
          type: number
          title: max_quantity
          description: The maximum quantity allowed to be available in the cart for the price to be applied.
        price_set_id:
          type: string
          title: price_set_id
          description: The ID of the price set this price belongs to.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price was deleted.
    AdminPriceListResponse:
      type: object
      description: The price list's details.
      x-schemaName: AdminPriceListResponse
      required:
        - price_list
      properties:
        price_list:
          $ref: '#/components/schemas/AdminPriceList'
    AdminPricePreference:
      type: object
      description: The price preference's details.
      x-schemaName: AdminPricePreference
      required:
        - id
        - attribute
        - value
        - is_tax_inclusive
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The price preference's ID.
        attribute:
          type: string
          title: attribute
          description: The price preference's attribute.
          example: region_id
        value:
          type: string
          title: value
          description: The price preference's value.
          example: reg_123
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: Whether prices matching this preference include taxes.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the price preference was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the price preference was updated.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the price preference was deleted.
    AdminPricePreferenceDeleteResponse:
      type: object
      description: The details of the deleted price preference.
      x-schemaName: AdminPricePreferenceDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The price preference's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: price_preference
        deleted:
          type: boolean
          title: deleted
          description: Whether the price preference was deleted.
    AdminPricePreferenceListResponse:
      type: object
      description: The paginated list of price preferences.
      x-schemaName: AdminPricePreferenceListResponse
      required:
        - limit
        - offset
        - count
        - price_preferences
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total count of items.
        price_preferences:
          type: array
          description: The list of price preferences.
          items:
            $ref: '#/components/schemas/AdminPricePreference'
    AdminPricePreferenceResponse:
      type: object
      description: The price preference's details.
      x-schemaName: AdminPricePreferenceResponse
      required:
        - price_preference
      properties:
        price_preference:
          $ref: '#/components/schemas/AdminPricePreference'
    AdminProduct:
      type: object
      description: The product's details.
      x-schemaName: AdminProduct
      required:
        - type
        - length
        - title
        - status
        - options
        - description
        - id
        - created_at
        - updated_at
        - handle
        - subtitle
        - is_giftcard
        - thumbnail
        - width
        - weight
        - height
        - origin_country
        - hs_code
        - mid_code
        - material
        - collection_id
        - type_id
        - images
        - discountable
        - external_id
        - deleted_at
      properties:
        collection:
          $ref: '#/components/schemas/AdminCollection'
        categories:
          type: array
          description: The product's categories.
          items:
            $ref: '#/components/schemas/AdminProductCategory'
        sales_channels:
          type: array
          description: The sales channels that the product is available in.
          items:
            $ref: '#/components/schemas/AdminSalesChannel'
        variants:
          type: array
          description: The product's variants.
          items:
            $ref: '#/components/schemas/AdminProductVariant'
        type:
          $ref: '#/components/schemas/AdminProductType'
        tags:
          type: array
          description: The product's tags.
          items:
            $ref: '#/components/schemas/AdminProductTag'
        length:
          type: number
          title: length
          description: The product's length.
        title:
          type: string
          title: title
          description: The product's title.
        status:
          type: string
          description: The product's status.
          enum:
            - draft
            - proposed
            - published
            - rejected
        options:
          type: array
          description: The product's options.
          items:
            $ref: '#/components/schemas/BaseProductOption'
        description:
          type: string
          title: description
          description: The product's description.
        id:
          type: string
          title: id
          description: The product's ID.
        metadata:
          type: object
          description: The product's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the product was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the product was updated.
        handle:
          type: string
          title: handle
          description: The product's unique handle.
        subtitle:
          type: string
          title: subtitle
          description: The product's subtitle.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: Whether the product is a gift card.
        thumbnail:
          type: string
          title: thumbnail
          description: The product's thumbnail.
        width:
          type: number
          title: width
          description: The product's width.
        weight:
          type: number
          title: weight
          description: The product's weight.
        height:
          type: number
          title: height
          description: The product's height.
        origin_country:
          type: string
          title: origin_country
          description: The product's origin country.
        hs_code:
          type: string
          title: hs_code
          description: The product's HS code.
        mid_code:
          type: string
          title: mid_code
          description: The product's MID code.
        material:
          type: string
          title: material
          description: The product's material.
        collection_id:
          type: string
          title: collection_id
          description: The ID of the collection that the product belongs to.
        type_id:
          type: string
          title: type_id
          description: The ID of the product's type.
        images:
          type: array
          description: The product's images.
          items:
            $ref: '#/components/schemas/BaseProductImage'
        discountable:
          type: boolean
          title: discountable
          description: Whether discounts can be applied on the product.
        external_id:
          type: string
          title: external_id
          description: The ID of a product in an external system, such as an ERP or CMS.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the product was deleted.
    AdminProductCategory:
      type: object
      description: The product category's details.
      x-schemaName: AdminProductCategory
      required:
        - category_children
        - parent_category
        - name
        - description
        - id
        - created_at
        - updated_at
        - handle
        - deleted_at
        - is_active
        - is_internal
        - rank
        - parent_category_id
      properties:
        category_children:
          type: array
          description: The category's children.
          items:
            type: object
        parent_category:
          type: object
        products:
          type: array
          description: The category's products.
          items:
            type: object
        name:
          type: string
          title: name
          description: The category's name.
        description:
          type: string
          title: description
          description: The category's description.
        id:
          type: string
          title: id
          description: The category's ID.
        metadata:
          type: object
          description: The category's metadata, can hold custom key-value pairs.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The date the category was created.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The date the category was updated.
        handle:
          type: string
          title: handle
          description: The category's unique handle.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The date the category was deleted.
        is_active:
          type: boolean
          title: is_active
          description: Whether the category is active. If disabled, the category isn't shown in the storefront.
        is_internal:
          type: boolean
          title: is_internal
          description: Whether the category is internal. If enabled, the category is only seen by admin users.
        rank:
          type: number
          title: rank
          description: The category's rank among sibling categories.
        parent_category_id:
          type: string
          title: parent_category_id
          description: The ID of the category's parent.
    AdminProductCategoryDeleteResponse:
      type: object
      description: The details of deleting the category.
      x-schemaName: AdminProductCategoryDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product category's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: product_category
        deleted:
          type: boolean
          title: deleted
          description: Whether the product category was deleted.
    AdminProductCategoryListResponse:
      type: object
      description: The paginated list of product categories.
      x-schemaName: AdminProductCategoryListResponse
      required:
        - limit
        - offset
        - count
        - product_categories
      properties:
        limit:
          type: number
          title: limit
          description: The maximum number of items returned.
        offset:
          type: number
          title: offset
          description: The number of items skipped before retrieving the returned items.
        count:
          type: number
          title: count
          description: The total number of items.
        product_categories:
          type: array
          description: The list of product categories.
          items:
            $ref: '#/components/schemas/AdminProductCategory'
    AdminProductCategoryResponse:
      type: object
      description: The product category's details.
      x-schemaName: AdminProductCategoryResponse
      required:
        - product_category
      properties:
        product_category:
          $ref: '#/components/schemas/AdminProductCategory'
    AdminProductDeleteResponse:
      type: object
      description: The details of the product deletion.
      x-schemaName: AdminProductDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: product
        deleted:
          type: boolean
          title: deleted
          description: Whether the product was deleted.
    AdminProductOption:
      type: object
      description: The product's product option.
      x-schemaName: AdminProductOption
      required:
        - id
        - title
      properties:
        id:
          type: string
          title: id
          description: The product option's ID.
        title:
          type: string
          title: title
          description: The product option's title.
        product:
          $ref: '#/components/schemas/BaseProduct'
        product_id:
          type: string
          title: product_id
          description: The product option's product id.
        values:
          type: array
          description: The product option's values.
          items:
            $ref: '#/components/schemas/BaseProductOptionValue'
        metadata:
          type: object
          description: The product option's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The product option's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The product option's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The product option's deleted at.
    AdminProductOptionDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductOptionDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
        deleted:
          type: boolean
          title: deleted
          description: Whether the Product was deleted.
        parent:
          $ref: '#/components/schemas/AdminProduct'
    AdminProductOptionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductOptionResponse
      required:
        - product_option
      properties:
        product_option:
          $ref: '#/components/schemas/AdminProductOption'
    AdminProductResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductResponse
      required:
        - product
      properties:
        product:
          $ref: '#/components/schemas/AdminProduct'
    AdminProductTag:
      type: object
      description: The tag's tags.
      x-schemaName: AdminProductTag
      required:
        - id
        - value
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The tag's ID.
        value:
          type: string
          title: value
          description: The tag's value.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The tag's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The tag's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The tag's deleted at.
        metadata:
          type: object
          description: The tag's metadata.
    AdminProductTagDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTagDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product tag's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: product_tag
        deleted:
          type: boolean
          title: deleted
          description: Whether the Product Tag was deleted.
    AdminProductTagListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTagListResponse
      required:
        - limit
        - offset
        - count
        - product_tags
      properties:
        limit:
          type: number
          title: limit
          description: The product tag's limit.
        offset:
          type: number
          title: offset
          description: The product tag's offset.
        count:
          type: number
          title: count
          description: The product tag's count.
        product_tags:
          type: array
          description: The product tag's product tags.
          items:
            $ref: '#/components/schemas/AdminProductTag'
    AdminProductTagResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTagResponse
      required:
        - product_tag
      properties:
        product_tag:
          $ref: '#/components/schemas/AdminProductTag'
    AdminProductType:
      type: object
      description: The parent's type.
      x-schemaName: AdminProductType
      required:
        - id
        - value
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The type's ID.
        value:
          type: string
          title: value
          description: The type's value.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The type's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The type's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The type's deleted at.
        metadata:
          type: object
          description: The type's metadata.
    AdminProductTypeDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTypeDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product type's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: product_type
        deleted:
          type: boolean
          title: deleted
          description: Whether the Product Type was deleted.
    AdminProductTypeListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTypeListResponse
      required:
        - limit
        - offset
        - count
        - product_types
      properties:
        limit:
          type: number
          title: limit
          description: The product type's limit.
        offset:
          type: number
          title: offset
          description: The product type's offset.
        count:
          type: number
          title: count
          description: The product type's count.
        product_types:
          type: array
          description: The product type's product types.
          items:
            $ref: '#/components/schemas/AdminProductType'
    AdminProductTypeResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductTypeResponse
      required:
        - product_type
      properties:
        product_type:
          $ref: '#/components/schemas/AdminProductType'
    AdminProductVariant:
      type: object
      description: The product's parent.
      x-schemaName: AdminProductVariant
      required:
        - prices
        - id
        - title
        - sku
        - barcode
        - ean
        - upc
        - allow_backorder
        - manage_inventory
        - hs_code
        - origin_country
        - mid_code
        - material
        - weight
        - length
        - height
        - width
        - options
        - created_at
        - updated_at
        - deleted_at
      properties:
        prices:
          type: array
          description: The parent's prices.
          items:
            $ref: '#/components/schemas/AdminPrice'
        id:
          type: string
          title: id
          description: The parent's ID.
        title:
          type: string
          title: title
          description: The parent's title.
        sku:
          type: string
          title: sku
          description: The parent's sku.
        barcode:
          type: string
          title: barcode
          description: The parent's barcode.
        ean:
          type: string
          title: ean
          description: The parent's ean.
        upc:
          type: string
          title: upc
          description: The parent's upc.
        allow_backorder:
          type: boolean
          title: allow_backorder
          description: The parent's allow backorder.
        manage_inventory:
          type: boolean
          title: manage_inventory
          description: The parent's manage inventory.
        inventory_quantity:
          type: number
          title: inventory_quantity
          description: The parent's inventory quantity.
        hs_code:
          type: string
          title: hs_code
          description: The parent's hs code.
        origin_country:
          type: string
          title: origin_country
          description: The parent's origin country.
        mid_code:
          type: string
          title: mid_code
          description: The parent's mid code.
        material:
          type: string
          title: material
          description: The parent's material.
        weight:
          type: number
          title: weight
          description: The parent's weight.
        length:
          type: number
          title: length
          description: The parent's length.
        height:
          type: number
          title: height
          description: The parent's height.
        width:
          type: number
          title: width
          description: The parent's width.
        variant_rank:
          type: number
          title: variant_rank
          description: The parent's variant rank.
        options:
          type: array
          description: The parent's options.
          items:
            $ref: '#/components/schemas/BaseProductOptionValue'
        product:
          $ref: '#/components/schemas/BaseProduct'
        product_id:
          type: string
          title: product_id
          description: The parent's product id.
        calculated_price:
          $ref: '#/components/schemas/BaseCalculatedPriceSet'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The parent's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The parent's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The parent's deleted at.
        metadata:
          type: object
          description: The parent's metadata.
    AdminProductVariantDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductVariantDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The product's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
        deleted:
          type: boolean
          title: deleted
          description: Whether the Product was deleted.
        parent:
          $ref: '#/components/schemas/AdminProduct'
    AdminProductVariantInventoryBatchResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductVariantInventoryBatchResponse
      required:
        - created
        - updated
        - deleted
      properties:
        created:
          oneOf:
            - $ref: '#/components/schemas/AdminProductVariantInventoryLink'
            - type: array
              description: The product's created.
              items:
                type: object
                description: The created's details.
                x-schemaName: AdminProductVariantInventoryLink
                required:
                  - productService
                  - inventoryService
                properties:
                  productService:
                    type: object
                    description: The created's productservice.
                    required:
                      - variant_id
                    properties:
                      variant_id:
                        type: string
                        title: variant_id
                        description: The productservice's variant id.
                  inventoryService:
                    type: object
                    description: The created's inventoryservice.
                    required:
                      - inventory_item_id
                    properties:
                      inventory_item_id:
                        type: string
                        title: inventory_item_id
                        description: The inventoryservice's inventory item id.
        updated:
          oneOf:
            - $ref: '#/components/schemas/AdminProductVariantInventoryLink'
            - type: array
              description: The product's updated.
              items:
                type: object
                description: The updated's details.
                x-schemaName: AdminProductVariantInventoryLink
                required:
                  - productService
                  - inventoryService
                properties:
                  productService:
                    type: object
                    description: The updated's productservice.
                    required:
                      - variant_id
                    properties:
                      variant_id:
                        type: string
                        title: variant_id
                        description: The productservice's variant id.
                  inventoryService:
                    type: object
                    description: The updated's inventoryservice.
                    required:
                      - inventory_item_id
                    properties:
                      inventory_item_id:
                        type: string
                        title: inventory_item_id
                        description: The inventoryservice's inventory item id.
        deleted:
          oneOf:
            - $ref: '#/components/schemas/AdminProductVariantInventoryLink'
            - type: array
              description: SUMMARY
              items:
                type: object
                description: SUMMARY
                x-schemaName: AdminProductVariantInventoryLink
                required:
                  - productService
                  - inventoryService
                properties:
                  productService:
                    type: object
                    description: The deleted's productservice.
                    required:
                      - variant_id
                    properties:
                      variant_id:
                        type: string
                        title: variant_id
                        description: The productservice's variant id.
                  inventoryService:
                    type: object
                    description: The deleted's inventoryservice.
                    required:
                      - inventory_item_id
                    properties:
                      inventory_item_id:
                        type: string
                        title: inventory_item_id
                        description: The inventoryservice's inventory item id.
    AdminProductVariantInventoryLink:
      type: object
      description: The product's ID.
      x-schemaName: AdminProductVariantInventoryLink
      required:
        - productService
        - inventoryService
      properties:
        productService:
          type: object
          description: The id's productservice.
          required:
            - variant_id
          properties:
            variant_id:
              type: string
              title: variant_id
              description: The productservice's variant id.
        inventoryService:
          type: object
          description: The id's inventoryservice.
          required:
            - inventory_item_id
          properties:
            inventory_item_id:
              type: string
              title: inventory_item_id
              description: The inventoryservice's inventory item id.
    AdminProductVariantInventoryLinkDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductVariantInventoryLinkDeleteResponse
      required:
        - id
        - object
        - deleted
        - parent
      properties:
        id:
          $ref: '#/components/schemas/AdminProductVariantInventoryLink'
        object:
          type: string
          title: object
          description: The name of the deleted object.
        deleted:
          type: boolean
          title: deleted
          description: Whether the Product was deleted.
        parent:
          $ref: '#/components/schemas/AdminProductVariant'
    AdminProductVariantParams:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductVariantParams
      properties:
        q:
          type: string
          title: q
          description: The product's q.
        id:
          oneOf:
            - type: string
              title: id
              description: The product's ID.
            - type: array
              description: The product's ID.
              items:
                type: string
                title: id
                description: The id's ID.
        manage_inventory:
          type: boolean
          title: manage_inventory
          description: The product's manage inventory.
        allow_backorder:
          type: boolean
          title: allow_backorder
          description: The product's allow backorder.
        created_at:
          type: object
          description: The product's created at.
          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.
                  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`).
                - 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`).
        updated_at:
          type: object
          description: The product's updated at.
          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.
                  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`).
                - 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`).
        deleted_at:
          type: object
          description: The product's deleted at.
          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.
                  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`).
                - 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`).
        limit:
          type: number
          title: limit
          description: The product's limit.
        offset:
          type: number
          title: offset
          description: The product's offset.
        order:
          type: string
          title: order
          description: The product's order.
        fields:
          type: string
          title: fields
          description: The product's fields.
        $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
    AdminProductVariantResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminProductVariantResponse
      required:
        - variant
      properties:
        variant:
          $ref: '#/components/schemas/AdminProductVariant'
    AdminPromotion:
      type: object
      description: The promotion's details.
      x-schemaName: AdminPromotion
      required:
        - id
      properties:
        id:
          type: string
          title: id
          description: The promotion's ID.
        code:
          type: string
          title: code
          description: The promotion's code.
        type:
          type: string
          description: The promotion's type.
          enum:
            - standard
            - buyget
        is_automatic:
          type: boolean
          title: is_automatic
          description: The promotion's is automatic.
        application_method:
          $ref: '#/components/schemas/BaseApplicationMethod'
        rules:
          type: array
          description: The promotion's rules.
          items:
            $ref: '#/components/schemas/BasePromotionRule'
        campaign_id:
          type: string
          title: campaign_id
          description: The promotion's campaign id.
        campaign:
          $ref: '#/components/schemas/AdminCampaign'
    AdminPromotionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminPromotionResponse
      required:
        - promotion
      properties:
        promotion:
          $ref: '#/components/schemas/AdminPromotion'
    AdminPromotionRule:
      type: object
      description: The updated's details.
      x-schemaName: AdminPromotionRule
      required:
        - id
        - values
      properties:
        id:
          type: string
          title: id
          description: The updated's ID.
        description:
          type: string
          title: description
          description: The updated's description.
        attribute:
          type: string
          title: attribute
          description: The updated's attribute.
        operator:
          type: string
          description: The updated's operator.
          enum:
            - gt
            - lt
            - eq
            - ne
            - in
            - lte
            - gte
        values:
          type: array
          description: The updated's values.
          items:
            $ref: '#/components/schemas/BasePromotionRuleValue'
    AdminRefundReason:
      type: object
      description: The refund reason's details.
      x-schemaName: AdminRefundReason
      required:
        - id
        - label
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The refund reason's ID.
        label:
          type: string
          title: label
          description: The refund reason's label.
        description:
          type: string
          title: description
          description: The refund reason's description.
        metadata:
          type: object
          description: The refund reason's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The refund reason's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The refund reason's updated at.
    AdminRegion:
      type: object
      description: The region's details.
      x-schemaName: AdminRegion
      required:
        - id
        - name
        - currency_code
      properties:
        id:
          type: string
          title: id
          description: The region's ID.
        name:
          type: string
          title: name
          description: The region's name.
        currency_code:
          type: string
          title: currency_code
          description: The region's currency code.
        automatic_taxes:
          type: boolean
          title: automatic_taxes
          description: The region's automatic taxes.
        countries:
          type: array
          description: The region's countries.
          items:
            $ref: '#/components/schemas/BaseRegionCountry'
        payment_providers:
          type: array
          description: The region's payment providers.
          items:
            $ref: '#/components/schemas/AdminPaymentProvider'
        metadata:
          type: object
          description: The region's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The region's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The region's updated at.
    AdminRegionCountry:
      type: object
      description: The billing address's country.
      x-schemaName: AdminRegionCountry
    AdminRegionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminRegionResponse
      required:
        - region
      properties:
        region:
          $ref: '#/components/schemas/AdminRegion'
    AdminReservation:
      type: object
      description: The reservation's details.
      x-schemaName: AdminReservation
      required:
        - id
        - line_item_id
        - location_id
        - quantity
        - external_id
        - description
        - inventory_item_id
        - inventory_item
      properties:
        id:
          type: string
          title: id
          description: The reservation's ID.
        line_item_id:
          type: string
          title: line_item_id
          description: The reservation's line item id.
        location_id:
          type: string
          title: location_id
          description: The reservation's location id.
        quantity:
          type: number
          title: quantity
          description: The reservation's quantity.
        external_id:
          type: string
          title: external_id
          description: The reservation's external id.
        description:
          type: string
          title: description
          description: The reservation's description.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The reservation's inventory item id.
        inventory_item:
          type: object
          description: The reservation's inventory item.
        metadata:
          type: object
          description: The reservation's metadata.
        created_by:
          type: string
          title: created_by
          description: The reservation's created by.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The reservation's deleted at.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The reservation's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The reservation's updated at.
    AdminReservationResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReservationResponse
      required:
        - reservation
      properties:
        reservation:
          $ref: '#/components/schemas/AdminReservation'
    AdminReturn:
      type: object
      description: The exchange's return.
      x-schemaName: AdminReturn
      required:
        - id
        - order_id
        - order_version
        - display_id
        - items
        - received_at
        - created_at
        - canceled_at
      properties:
        id:
          type: string
          title: id
          description: The return's ID.
        order_id:
          type: string
          title: order_id
          description: The return's order id.
        status:
          type: string
          title: status
          description: The return's status.
        exchange_id:
          type: string
          title: exchange_id
          description: The return's exchange id.
        location_id:
          type: string
          title: location_id
          description: The return's location id.
        claim_id:
          type: string
          title: claim_id
          description: The return's claim id.
        order_version:
          type: number
          title: order_version
          description: The return's order version.
        display_id:
          type: number
          title: display_id
          description: The return's display id.
        no_notification:
          type: boolean
          title: no_notification
          description: The return's no notification.
        refund_amount:
          type: number
          title: refund_amount
          description: The return's refund amount.
        items:
          type: array
          description: The return's items.
          items:
            $ref: '#/components/schemas/BaseReturnItem'
        received_at:
          type: string
          title: received_at
          description: The return's received at.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The return's created at.
        canceled_at:
          type: string
          title: canceled_at
          description: The return's canceled at.
    AdminReturnItem:
      type: object
      description: The return item's return items.
      x-schemaName: AdminReturnItem
      required:
        - id
        - quantity
        - received_quantity
        - damaged_quantity
        - item_id
        - return_id
      properties:
        id:
          type: string
          title: id
          description: The return item's ID.
        quantity:
          type: number
          title: quantity
          description: The return item's quantity.
        received_quantity:
          type: number
          title: received_quantity
          description: The return item's received quantity.
        damaged_quantity:
          type: number
          title: damaged_quantity
          description: The return item's damaged quantity.
        reason_id:
          type: string
          title: reason_id
          description: The return item's reason id.
        note:
          type: string
          title: note
          description: The return item's note.
        item_id:
          type: string
          title: item_id
          description: The return item's item id.
        return_id:
          type: string
          title: return_id
          description: The return item's return id.
        metadata:
          type: object
          description: The return item's metadata.
    AdminReturnPreviewResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReturnPreviewResponse
      required:
        - order_preview
        - return
      properties:
        order_preview:
          $ref: '#/components/schemas/AdminOrderPreview'
        return:
          $ref: '#/components/schemas/AdminReturn'
    AdminReturnReason:
      type: object
      description: The return reason's details.
      x-schemaName: AdminReturnReason
      required:
        - id
        - value
        - label
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The return reason's ID.
        value:
          type: string
          title: value
          description: The return reason's value.
        label:
          type: string
          title: label
          description: The return reason's label.
        description:
          type: string
          title: description
          description: The return reason's description.
        metadata:
          type: object
          description: The return reason's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The return reason's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The return reason's updated at.
    AdminReturnReasonDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReturnReasonDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The return reason's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: return_reason
        deleted:
          type: boolean
          title: deleted
          description: Whether the Return Reason was deleted.
    AdminReturnReasonListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReturnReasonListResponse
      required:
        - limit
        - offset
        - count
        - return_reasons
      properties:
        limit:
          type: number
          title: limit
          description: The return reason's limit.
        offset:
          type: number
          title: offset
          description: The return reason's offset.
        count:
          type: number
          title: count
          description: The return reason's count.
        return_reasons:
          type: array
          description: The return reason's return reasons.
          items:
            $ref: '#/components/schemas/AdminReturnReason'
    AdminReturnReasonResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReturnReasonResponse
      required:
        - return_reason
      properties:
        return_reason:
          $ref: '#/components/schemas/AdminReturnReason'
    AdminReturnResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminReturnResponse
      required:
        - return
      properties:
        return:
          $ref: '#/components/schemas/AdminReturn'
    AdminRevokeApiKey:
      type: object
      description: SUMMARY
      x-schemaName: AdminRevokeApiKey
      properties:
        revoke_in:
          type: number
          title: revoke_in
          description: The api key's revoke in.
    AdminRuleAttributeOption:
      type: object
      description: The attribute's attributes.
      x-schemaName: AdminRuleAttributeOption
      required:
        - id
        - value
        - label
        - field_type
        - required
        - disguised
        - operators
      properties:
        id:
          type: string
          title: id
          description: The attribute's ID.
        value:
          type: string
          title: value
          description: The attribute's value.
        label:
          type: string
          title: label
          description: The attribute's label.
        field_type:
          type: string
          title: field_type
          description: The attribute's field type.
        required:
          type: boolean
          title: required
          description: The attribute's required.
        disguised:
          type: boolean
          title: disguised
          description: The attribute's disguised.
        operators:
          type: array
          description: The attribute's operators.
          items:
            $ref: '#/components/schemas/BaseRuleOperatorOptions'
    AdminRuleValueOption:
      type: object
      description: The value's values.
      x-schemaName: AdminRuleValueOption
      required:
        - id
        - value
        - label
      properties:
        id:
          type: string
          title: id
          description: The value's ID.
        value:
          type: string
          title: value
          description: The value's details.
        label:
          type: string
          title: label
          description: The value's label.
    AdminSalesChannel:
      type: object
      description: The order's sales channel.
      x-schemaName: AdminSalesChannel
      required:
        - id
        - name
        - description
        - is_disabled
        - metadata
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The sales channel's ID.
        name:
          type: string
          title: name
          description: The sales channel's name.
        description:
          type: string
          title: description
          description: The sales channel's description.
        is_disabled:
          type: boolean
          title: is_disabled
          description: The sales channel's is disabled.
        metadata:
          type: object
          description: The sales channel's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The sales channel's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The sales channel's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The sales channel's deleted at.
    AdminSalesChannelDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminSalesChannelDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The sales channel's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: sales-channel
        deleted:
          type: boolean
          title: deleted
          description: Whether the Sales Channel was deleted.
    AdminSalesChannelResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminSalesChannelResponse
      required:
        - sales_channel
      properties:
        sales_channel:
          $ref: '#/components/schemas/AdminSalesChannel'
    AdminServiceZone:
      type: object
      description: The service zone's service zones.
      x-schemaName: AdminServiceZone
      required:
        - id
        - name
        - fulfillment_set_id
        - fulfillment_set
        - geo_zones
        - shipping_options
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The service zone's ID.
        name:
          type: string
          title: name
          description: The service zone's name.
        fulfillment_set_id:
          type: string
          title: fulfillment_set_id
          description: The service zone's fulfillment set id.
        fulfillment_set:
          type: object
        geo_zones:
          type: array
          description: The service zone's geo zones.
          items:
            $ref: '#/components/schemas/AdminGeoZone'
        shipping_options:
          type: array
          description: The service zone's shipping options.
          items:
            $ref: '#/components/schemas/AdminShippingOption'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The service zone's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The service zone's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The service zone's deleted at.
    AdminServiceZoneDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminServiceZoneDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The fulfillment set's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
        deleted:
          type: boolean
          title: deleted
          description: Whether the Fulfillment Set was deleted.
        parent:
          $ref: '#/components/schemas/AdminFulfillmentSet'
    AdminServiceZoneResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminServiceZoneResponse
      required:
        - service_zone
      properties:
        service_zone:
          $ref: '#/components/schemas/AdminServiceZone'
    AdminShippingOption:
      type: object
      description: The shipping option's shipping options.
      x-schemaName: AdminShippingOption
    AdminShippingOptionDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminShippingOptionDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The shipping option's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: shipping_option
        deleted:
          type: boolean
          title: deleted
          description: Whether the Shipping Option was deleted.
    AdminShippingOptionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminShippingOptionResponse
      required:
        - shipping_option
      properties:
        shipping_option:
          $ref: '#/components/schemas/AdminShippingOption'
    AdminShippingOptionRule:
      type: object
      description: The updated's details.
      x-schemaName: AdminShippingOptionRule
      required:
        - id
        - attribute
        - operator
        - value
        - shipping_option_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The updated's ID.
        attribute:
          type: string
          title: attribute
          description: The updated's attribute.
        operator:
          type: string
          title: operator
          description: The updated's operator.
        value:
          oneOf:
            - type: string
              title: value
              description: The updated's value.
            - type: array
              description: The updated's value.
              items:
                type: string
                title: value
                description: The value's details.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The updated's shipping option id.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The updated's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The updated's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The updated's deleted at.
    AdminShippingProfile:
      type: object
      description: The shipping option's shipping profile.
      x-schemaName: AdminShippingProfile
    AdminShippingProfileDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminShippingProfileDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The shipping profile's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: shipping_profile
        deleted:
          type: boolean
          title: deleted
          description: Whether the Shipping Profile was deleted.
    AdminShippingProfileResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminShippingProfileResponse
      required:
        - shipping_profile
      properties:
        shipping_profile:
          $ref: '#/components/schemas/AdminShippingProfile'
    AdminStockLocation:
      type: object
      description: The parent's location.
      x-schemaName: AdminStockLocation
      required:
        - id
        - name
        - address_id
      properties:
        id:
          type: string
          title: id
          description: The location's ID.
        name:
          type: string
          title: name
          description: The location's name.
        address_id:
          type: string
          title: address_id
          description: The location's address id.
        address:
          $ref: '#/components/schemas/AdminStockLocationAddress'
        sales_channels:
          type: array
          description: The location's sales channels.
          items:
            $ref: '#/components/schemas/AdminSalesChannel'
        fulfillment_providers:
          type: array
          description: The location's fulfillment providers.
          items:
            $ref: '#/components/schemas/AdminFulfillmentProvider'
        fulfillment_sets:
          type: array
          description: The location's fulfillment sets.
          items:
            type: object
    AdminStockLocationAddress:
      type: object
      description: The location's address.
      x-schemaName: AdminStockLocationAddress
    AdminStockLocationDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminStockLocationDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The stock location's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: stock_location
        deleted:
          type: boolean
          title: deleted
          description: Whether the Stock Location was deleted.
    AdminStockLocationListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminStockLocationListResponse
      required:
        - limit
        - offset
        - count
        - stock_locations
      properties:
        limit:
          type: number
          title: limit
          description: The stock location's limit.
        offset:
          type: number
          title: offset
          description: The stock location's offset.
        count:
          type: number
          title: count
          description: The stock location's count.
        stock_locations:
          type: array
          description: The stock location's stock locations.
          items:
            $ref: '#/components/schemas/AdminStockLocation'
    AdminStockLocationResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminStockLocationResponse
      required:
        - stock_location
      properties:
        stock_location:
          $ref: '#/components/schemas/AdminStockLocation'
    AdminStore:
      type: object
      description: The store's details.
      x-schemaName: AdminStore
      required:
        - id
        - name
        - supported_currencies
        - default_sales_channel_id
        - default_region_id
        - default_location_id
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The store's ID.
        name:
          type: string
          title: name
          description: The store's name.
        supported_currencies:
          type: array
          description: The store's supported currencies.
          items:
            $ref: '#/components/schemas/AdminStoreCurrency'
        default_sales_channel_id:
          type: string
          title: default_sales_channel_id
          description: The store's default sales channel id.
        default_region_id:
          type: string
          title: default_region_id
          description: The store's default region id.
        default_location_id:
          type: string
          title: default_location_id
          description: The store's default location id.
        metadata:
          type: object
          description: The store's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The store's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The store's updated at.
    AdminStoreCurrency:
      type: object
      description: The supported currency's supported currencies.
      x-schemaName: AdminStoreCurrency
      required:
        - id
        - currency_code
        - store_id
        - is_default
        - currency
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The supported currency's ID.
        currency_code:
          type: string
          title: currency_code
          description: The supported currency's currency code.
        store_id:
          type: string
          title: store_id
          description: The supported currency's store id.
        is_default:
          type: boolean
          title: is_default
          description: The supported currency's is default.
        currency:
          $ref: '#/components/schemas/AdminCurrency'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The supported currency's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The supported currency's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The supported currency's deleted at.
    AdminStoreListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminStoreListResponse
      required:
        - limit
        - offset
        - count
        - stores
      properties:
        limit:
          type: number
          title: limit
          description: The store's limit.
        offset:
          type: number
          title: offset
          description: The store's offset.
        count:
          type: number
          title: count
          description: The store's count.
        stores:
          type: array
          description: The store's stores.
          items:
            $ref: '#/components/schemas/AdminStore'
    AdminStoreResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminStoreResponse
      required:
        - store
      properties:
        store:
          $ref: '#/components/schemas/AdminStore'
    AdminTaxRate:
      type: object
      description: The tax rate's parent.
      x-schemaName: AdminTaxRate
      required:
        - id
        - rate
        - code
        - name
        - metadata
        - tax_region_id
        - is_combinable
        - is_default
        - created_at
        - updated_at
        - deleted_at
        - created_by
        - tax_region
        - rules
      properties:
        id:
          type: string
          title: id
          description: The parent's ID.
        rate:
          type: number
          title: rate
          description: The parent's rate.
        code:
          type: string
          title: code
          description: The parent's code.
        name:
          type: string
          title: name
          description: The parent's name.
        metadata:
          type: object
          description: The parent's metadata.
        tax_region_id:
          type: string
          title: tax_region_id
          description: The parent's tax region id.
        is_combinable:
          type: boolean
          title: is_combinable
          description: The parent's is combinable.
        is_default:
          type: boolean
          title: is_default
          description: The parent's is default.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The parent's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The parent's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The parent's deleted at.
        created_by:
          type: string
          title: created_by
          description: The parent's created by.
        tax_region:
          $ref: '#/components/schemas/AdminTaxRegion'
        rules:
          type: array
          description: The parent's rules.
          items:
            $ref: '#/components/schemas/AdminTaxRateRule'
    AdminTaxRateDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminTaxRateDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The tax rate's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: tax_rate
        deleted:
          type: boolean
          title: deleted
          description: Whether the Tax Rate was deleted.
    AdminTaxRateResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminTaxRateResponse
      required:
        - tax_rate
      properties:
        tax_rate:
          $ref: '#/components/schemas/AdminTaxRate'
    AdminTaxRateRule:
      type: object
      description: The rule's rules.
      x-schemaName: AdminTaxRateRule
      required:
        - reference
        - reference_id
      properties:
        reference:
          type: string
          title: reference
          description: The rule's reference.
        reference_id:
          type: string
          title: reference_id
          description: The rule's reference id.
    AdminTaxRegion:
      type: object
      description: The parent's tax region.
      x-schemaName: AdminTaxRegion
      required:
        - id
        - rate
        - code
        - country_code
        - province_code
        - name
        - metadata
        - tax_region_id
        - is_combinable
        - is_default
        - parent_id
        - created_at
        - updated_at
        - deleted_at
        - created_by
        - tax_rates
        - parent
        - children
      properties:
        id:
          type: string
          title: id
          description: The tax region's ID.
        rate:
          type: number
          title: rate
          description: The tax region's rate.
        code:
          type: string
          title: code
          description: The tax region's code.
        country_code:
          type: string
          title: country_code
          description: The tax region's country code.
        province_code:
          type: string
          title: province_code
          description: The tax region's province code.
        name:
          type: string
          title: name
          description: The tax region's name.
        metadata:
          type: object
          description: The tax region's metadata.
        tax_region_id:
          type: string
          title: tax_region_id
          description: The tax region's tax region id.
        is_combinable:
          type: boolean
          title: is_combinable
          description: The tax region's is combinable.
        is_default:
          type: boolean
          title: is_default
          description: The tax region's is default.
        parent_id:
          type: string
          title: parent_id
          description: The tax region's parent id.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The tax region's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The tax region's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The tax region's deleted at.
        created_by:
          type: string
          title: created_by
          description: The tax region's created by.
        tax_rates:
          type: array
          description: The tax region's tax rates.
          items:
            type: object
        parent:
          type: object
        children:
          type: array
          description: The tax region's children.
          items:
            type: object
    AdminTaxRegionDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminTaxRegionDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The tax region's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: tax_region
        deleted:
          type: boolean
          title: deleted
          description: Whether the Tax Region was deleted.
    AdminTaxRegionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminTaxRegionResponse
      required:
        - tax_region
      properties:
        tax_region:
          $ref: '#/components/schemas/AdminTaxRegion'
    AdminUpdateApiKey:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateApiKey
      required:
        - title
      properties:
        title:
          type: string
          title: title
          description: The api key's title.
    AdminUpdateCollection:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateCollection
      properties:
        title:
          type: string
          title: title
          description: The collection's title.
        handle:
          type: string
          title: handle
          description: The collection's handle.
        metadata:
          type: object
          description: The collection's metadata.
    AdminUpdateCustomerGroup:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateCustomerGroup
      properties:
        name:
          type: string
          title: name
          description: The customer group's name.
        metadata:
          type: object
          description: The customer group's metadata.
    AdminUpdatePriceList:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdatePriceList
      properties:
        title:
          type: string
          title: title
          description: The price list's title.
        description:
          type: string
          title: description
          description: The price list's description.
        starts_at:
          type: string
          title: starts_at
          description: The price list's starts at.
        ends_at:
          type: string
          title: ends_at
          description: The price list's ends at.
        status:
          type: string
          description: The price list's status.
          enum:
            - active
            - draft
        type:
          type: string
          description: The price list's type.
          enum:
            - sale
            - override
        rules:
          type: object
          description: The price list's rules.
    AdminUpdatePricePreference:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdatePricePreference
      properties:
        attribute:
          type: string
          title: attribute
          description: The price preference's attribute.
        value:
          type: string
          title: value
          description: The price preference's value.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The price preference's is tax inclusive.
    AdminUpdateProduct:
      type: object
      description: The update's details.
      x-schemaName: AdminUpdateProduct
      properties:
        title:
          type: string
          title: title
          description: The update's title.
        subtitle:
          type: string
          title: subtitle
          description: The update's subtitle.
        description:
          type: string
          title: description
          description: The update's description.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: The update's is giftcard.
        discountable:
          type: boolean
          title: discountable
          description: The update's discountable.
        images:
          type: array
          description: The update's images.
          items:
            type: object
            description: The image's images.
            required:
              - url
            properties:
              url:
                type: string
                title: url
                description: The image's url.
        thumbnail:
          type: string
          title: thumbnail
          description: The update's thumbnail.
        handle:
          type: string
          title: handle
          description: The update's handle.
        status:
          type: string
          description: The update's status.
          enum:
            - draft
            - proposed
            - published
            - rejected
        type_id:
          type: string
          title: type_id
          description: The update's type id.
        collection_id:
          type: string
          title: collection_id
          description: The update's collection id.
        categories:
          type: array
          description: The update's categories.
          items:
            type: object
            description: The category's categories.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The category's ID.
        tags:
          type: array
          description: The update's tags.
          items:
            type: object
            description: The tag's tags.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The tag's ID.
        options:
          type: array
          description: The update's options.
          items:
            $ref: '#/components/schemas/AdminUpdateProductOption'
        variants:
          type: array
          description: The update's variants.
          items:
            oneOf:
              - type: object
                description: The variant's variants.
                x-schemaName: AdminCreateProductVariant
                required:
                  - title
                  - prices
                properties:
                  title:
                    type: string
                    title: title
                    description: The variant's title.
                  sku:
                    type: string
                    title: sku
                    description: The variant's sku.
                  ean:
                    type: string
                    title: ean
                    description: The variant's ean.
                  upc:
                    type: string
                    title: upc
                    description: The variant's upc.
                  barcode:
                    type: string
                    title: barcode
                    description: The variant's barcode.
                  hs_code:
                    type: string
                    title: hs_code
                    description: The variant's hs code.
                  mid_code:
                    type: string
                    title: mid_code
                    description: The variant's mid code.
                  allow_backorder:
                    type: boolean
                    title: allow_backorder
                    description: The variant's allow backorder.
                  manage_inventory:
                    type: boolean
                    title: manage_inventory
                    description: The variant's manage inventory.
                  variant_rank:
                    type: number
                    title: variant_rank
                    description: The variant's variant rank.
                  weight:
                    type: number
                    title: weight
                    description: The variant's weight.
                  length:
                    type: number
                    title: length
                    description: The variant's length.
                  height:
                    type: number
                    title: height
                    description: The variant's height.
                  width:
                    type: number
                    title: width
                    description: The variant's width.
                  origin_country:
                    type: string
                    title: origin_country
                    description: The variant's origin country.
                  material:
                    type: string
                    title: material
                    description: The variant's material.
                  metadata:
                    type: object
                    description: The variant's metadata.
                  prices:
                    type: array
                    description: The variant's prices.
                    items:
                      $ref: '#/components/schemas/AdminCreateProductVariantPrice'
                  options:
                    type: object
                    description: The variant's options.
              - type: object
                description: The variant's variants.
                x-schemaName: AdminUpdateProductVariant
                properties:
                  title:
                    type: string
                    title: title
                    description: The variant's title.
                  sku:
                    type: string
                    title: sku
                    description: The variant's sku.
                  ean:
                    type: string
                    title: ean
                    description: The variant's ean.
                  upc:
                    type: string
                    title: upc
                    description: The variant's upc.
                  barcode:
                    type: string
                    title: barcode
                    description: The variant's barcode.
                  hs_code:
                    type: string
                    title: hs_code
                    description: The variant's hs code.
                  mid_code:
                    type: string
                    title: mid_code
                    description: The variant's mid code.
                  allow_backorder:
                    type: boolean
                    title: allow_backorder
                    description: The variant's allow backorder.
                  manage_inventory:
                    type: boolean
                    title: manage_inventory
                    description: The variant's manage inventory.
                  variant_rank:
                    type: number
                    title: variant_rank
                    description: The variant's variant rank.
                  weight:
                    type: number
                    title: weight
                    description: The variant's weight.
                  length:
                    type: number
                    title: length
                    description: The variant's length.
                  height:
                    type: number
                    title: height
                    description: The variant's height.
                  width:
                    type: number
                    title: width
                    description: The variant's width.
                  origin_country:
                    type: string
                    title: origin_country
                    description: The variant's origin country.
                  material:
                    type: string
                    title: material
                    description: The variant's material.
                  metadata:
                    type: object
                    description: The variant's metadata.
                  prices:
                    type: array
                    description: The variant's prices.
                    items:
                      $ref: '#/components/schemas/AdminCreateProductVariantPrice'
                  options:
                    type: object
                    description: The variant's options.
        sales_channels:
          type: array
          description: The update's sales channels.
          items:
            type: object
            description: The sales channel's sales channels.
            required:
              - id
            properties:
              id:
                type: string
                title: id
                description: The sales channel's ID.
        weight:
          type: number
          title: weight
          description: The update's weight.
        length:
          type: number
          title: length
          description: The update's length.
        height:
          type: number
          title: height
          description: The update's height.
        width:
          type: number
          title: width
          description: The update's width.
        hs_code:
          type: string
          title: hs_code
          description: The update's hs code.
        mid_code:
          type: string
          title: mid_code
          description: The update's mid code.
        origin_country:
          type: string
          title: origin_country
          description: The update's origin country.
        material:
          type: string
          title: material
          description: The update's material.
        metadata:
          type: object
          description: The update's metadata.
    AdminUpdateProductOption:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateProductOption
      properties:
        title:
          type: string
          title: title
          description: The product's title.
        values:
          type: array
          description: The product's values.
          items:
            type: string
            title: values
            description: The value's values.
    AdminUpdateProductVariant:
      type: object
      description: The update's details.
      x-schemaName: AdminUpdateProductVariant
      properties:
        title:
          type: string
          title: title
          description: The update's title.
        sku:
          type: string
          title: sku
          description: The update's sku.
        ean:
          type: string
          title: ean
          description: The update's ean.
        upc:
          type: string
          title: upc
          description: The update's upc.
        barcode:
          type: string
          title: barcode
          description: The update's barcode.
        hs_code:
          type: string
          title: hs_code
          description: The update's hs code.
        mid_code:
          type: string
          title: mid_code
          description: The update's mid code.
        allow_backorder:
          type: boolean
          title: allow_backorder
          description: The update's allow backorder.
        manage_inventory:
          type: boolean
          title: manage_inventory
          description: The update's manage inventory.
        variant_rank:
          type: number
          title: variant_rank
          description: The update's variant rank.
        weight:
          type: number
          title: weight
          description: The update's weight.
        length:
          type: number
          title: length
          description: The update's length.
        height:
          type: number
          title: height
          description: The update's height.
        width:
          type: number
          title: width
          description: The update's width.
        origin_country:
          type: string
          title: origin_country
          description: The update's origin country.
        material:
          type: string
          title: material
          description: The update's material.
        metadata:
          type: object
          description: The update's metadata.
        prices:
          type: array
          description: The update's prices.
          items:
            $ref: '#/components/schemas/AdminCreateProductVariantPrice'
        options:
          type: object
          description: The update's options.
    AdminUpdateSalesChannel:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateSalesChannel
      properties:
        name:
          type: string
          title: name
          description: The sales channel's name.
        description:
          type: string
          title: description
          description: The sales channel's description.
        is_disabled:
          type: boolean
          title: is_disabled
          description: The sales channel's is disabled.
        metadata:
          type: object
          description: The sales channel's metadata.
    AdminUpdateStockLocation:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateStockLocation
      properties:
        name:
          type: string
          title: name
          description: The stock location's name.
        address:
          type: object
          description: The stock location's address.
          required:
            - address_1
            - country_code
          properties:
            address_1:
              type: string
              title: address_1
              description: The address's address 1.
            address_2:
              type: string
              title: address_2
              description: The address's address 2.
            company:
              type: string
              title: company
              description: The address's company.
            city:
              type: string
              title: city
              description: The address's city.
            country_code:
              type: string
              title: country_code
              description: The address's country code.
            phone:
              type: string
              title: phone
              description: The address's phone.
            postal_code:
              type: string
              title: postal_code
              description: The address's postal code.
            province:
              type: string
              title: province
              description: The address's province.
        address_id:
          type: string
          title: address_id
          description: The stock location's address id.
        metadata:
          type: object
          description: The stock location's metadata.
    AdminUpdateStore:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateStore
      properties:
        name:
          type: string
          title: name
          description: The store's name.
        supported_currencies:
          type: array
          description: The store's supported currencies.
          items:
            type: object
            description: The supported currency's supported currencies.
            required:
              - currency_code
            properties:
              currency_code:
                type: string
                title: currency_code
                description: The supported currency's currency code.
              is_default:
                type: boolean
                title: is_default
                description: The supported currency's is default.
              is_tax_inclusive:
                type: boolean
                title: is_tax_inclusive
                description: The supported currency's is tax inclusive.
        default_sales_channel_id:
          type: string
          title: default_sales_channel_id
          description: The store's default sales channel id.
        default_region_id:
          type: string
          title: default_region_id
          description: The store's default region id.
        default_location_id:
          type: string
          title: default_location_id
          description: The store's default location id.
        metadata:
          type: object
          description: The store's metadata.
    AdminUpdateTaxRate:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateTaxRate
      properties:
        rate:
          type: number
          title: rate
          description: The tax rate's rate.
        code:
          type: string
          title: code
          description: The tax rate's code.
        rules:
          type: array
          description: The tax rate's rules.
          items:
            type: object
            description: The rule's rules.
            required:
              - reference
              - reference_id
            properties:
              reference:
                type: string
                title: reference
                description: The rule's reference.
              reference_id:
                type: string
                title: reference_id
                description: The rule's reference id.
        name:
          type: string
          title: name
          description: The tax rate's name.
        is_default:
          type: boolean
          title: is_default
          description: The tax rate's is default.
        is_combinable:
          type: boolean
          title: is_combinable
          description: The tax rate's is combinable.
        metadata:
          type: object
          description: The tax rate's metadata.
    AdminUpdateUser:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateUser
      properties:
        first_name:
          type: string
          title: first_name
          description: The user's first name.
        last_name:
          type: string
          title: last_name
          description: The user's last name.
        avatar_url:
          type: string
          title: avatar_url
          description: The user's avatar url.
    AdminUpdateVariantInventoryItem:
      type: object
      description: SUMMARY
      x-schemaName: AdminUpdateVariantInventoryItem
      required:
        - required_quantity
      properties:
        required_quantity:
          type: number
          title: required_quantity
          description: The product's required quantity.
    AdminUpsertStockLocationAddress:
      type: object
      description: The stock location's address.
      x-schemaName: AdminUpsertStockLocationAddress
      required:
        - address_1
        - country_code
      properties:
        address_1:
          type: string
          title: address_1
          description: The address's address 1.
        address_2:
          type: string
          title: address_2
          description: The address's address 2.
        company:
          type: string
          title: company
          description: The address's company.
        country_code:
          type: string
          title: country_code
          description: The address's country code.
        city:
          type: string
          title: city
          description: The address's city.
        phone:
          type: string
          title: phone
          description: The address's phone.
        postal_code:
          type: string
          title: postal_code
          description: The address's postal code.
        province:
          type: string
          title: province
          description: The address's province.
    AdminUser:
      type: object
      description: The user's details.
      x-schemaName: AdminUser
      required:
        - id
        - email
        - first_name
        - last_name
        - avatar_url
        - metadata
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The user's ID.
        email:
          type: string
          title: email
          description: The user's email.
          format: email
        first_name:
          type: string
          title: first_name
          description: The user's first name.
        last_name:
          type: string
          title: last_name
          description: The user's last name.
        avatar_url:
          type: string
          title: avatar_url
          description: The user's avatar url.
        metadata:
          type: object
          description: The user's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The user's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The user's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The user's deleted at.
    AdminUserDeleteResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminUserDeleteResponse
      required:
        - id
        - object
        - deleted
      properties:
        id:
          type: string
          title: id
          description: The user's ID.
        object:
          type: string
          title: object
          description: The name of the deleted object.
          default: user
        deleted:
          type: boolean
          title: deleted
          description: Whether the User was deleted.
    AdminUserListResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminUserListResponse
      required:
        - limit
        - offset
        - count
        - users
      properties:
        limit:
          type: number
          title: limit
          description: The user's limit.
        offset:
          type: number
          title: offset
          description: The user's offset.
        count:
          type: number
          title: count
          description: The user's count.
        users:
          type: array
          description: The user's users.
          items:
            $ref: '#/components/schemas/AdminUser'
    AdminUserResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminUserResponse
      required:
        - user
      properties:
        user:
          $ref: '#/components/schemas/AdminUser'
    AdminWorkflowExecution:
      type: object
      description: The workflows execution's workflow execution.
      x-schemaName: AdminWorkflowExecution
      required:
        - id
        - workflow_id
        - transaction_id
        - execution
        - context
        - state
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The workflow execution's ID.
        workflow_id:
          type: string
          title: workflow_id
          description: The workflow execution's workflow id.
        transaction_id:
          type: string
          title: transaction_id
          description: The workflow execution's transaction id.
        execution:
          $ref: '#/components/schemas/AdminWorkflowExecutionExecution'
        context:
          $ref: '#/components/schemas/WorkflowExecutionContext'
        state:
          type: string
          description: The workflow execution's state.
          enum:
            - not_started
            - invoking
            - waiting_to_compensate
            - compensating
            - done
            - reverted
            - failed
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The workflow execution's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The workflow execution's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The workflow execution's deleted at.
    AdminWorkflowExecutionExecution:
      type: object
      description: The workflow execution's execution.
      x-schemaName: AdminWorkflowExecutionExecution
      required:
        - steps
      properties:
        steps:
          type: object
          description: The execution's steps.
    AdminWorkflowExecutionResponse:
      type: object
      description: SUMMARY
      x-schemaName: AdminWorkflowExecutionResponse
      required:
        - workflow_execution
      properties:
        workflow_execution:
          $ref: '#/components/schemas/AdminWorkflowExecution'
    ApiKeyResponse:
      type: object
      description: The api key's details.
      x-schemaName: ApiKeyResponse
      required:
        - id
        - token
        - redacted
        - title
        - type
        - last_used_at
        - created_by
        - created_at
        - revoked_by
        - revoked_at
      properties:
        id:
          type: string
          title: id
          description: The api key's ID.
        token:
          type: string
          title: token
          description: The api key's token.
        redacted:
          type: string
          title: redacted
          description: The api key's redacted.
        title:
          type: string
          title: title
          description: The api key's title.
        type:
          type: string
          enum:
            - secret
            - publishable
        last_used_at:
          type: string
          title: last_used_at
          description: The api key's last used at.
          format: date-time
        created_by:
          type: string
          title: created_by
          description: The api key's created by.
        created_at:
          type: string
          title: created_at
          description: The api key's created at.
          format: date-time
        revoked_by:
          type: string
          title: revoked_by
          description: The api key's revoked by.
        revoked_at:
          type: string
          title: revoked_at
          description: The api key's revoked at.
          format: date-time
    AuthAdminSessionResponse:
      type: object
      description: The authenticated user's details.
      x-schemaName: AuthAdminSessionResponse
      required:
        - user
      properties:
        user:
          title: user
          description: The logged-in user.
          $ref: '#/components/schemas/AdminUser'
    AuthCallbackResponse:
      type: object
      description: The authentication's details.
      x-schemaName: AuthCallbackResponse
      required:
        - location
      properties:
        token:
          type: string
          title: location
          description: The location to redirect the user to for further authentication with the third-party provider.
    AuthResponse:
      type: object
      description: The authentication's details.
      x-schemaName: AuthResponse
      required:
        - token
      properties:
        token:
          type: string
          title: token
          description: The JWT token used for registration or authentication.
    AuthStoreSessionResponse:
      type: object
      description: The authenticated customer's details.
      x-schemaName: AuthStoreSessionResponse
      required:
        - user
      properties:
        user:
          title: user
          description: The logged-in customer.
          $ref: '#/components/schemas/StoreCustomer'
    BaseApplicationMethod:
      type: object
      description: The promotion's application method.
      x-schemaName: BaseApplicationMethod
      required:
        - id
      properties:
        id:
          type: string
          title: id
          description: The application method's ID.
        type:
          type: string
          description: The application method's type.
          enum:
            - fixed
            - percentage
        target_type:
          type: string
          description: The application method's target type.
          enum:
            - items
            - shipping_methods
            - order
        allocation:
          type: string
          description: The application method's allocation.
          enum:
            - each
            - across
        value:
          type: number
          title: value
          description: The application method's value.
        currency_code:
          type: string
          title: currency_code
          description: The application method's currency code.
        max_quantity:
          type: number
          title: max_quantity
          description: The application method's max quantity.
        buy_rules_min_quantity:
          type: number
          title: buy_rules_min_quantity
          description: The application method's buy rules min quantity.
        apply_to_quantity:
          type: number
          title: apply_to_quantity
          description: The application method's apply to quantity.
        promotion:
          $ref: '#/components/schemas/BasePromotion'
        target_rules:
          type: array
          description: The application method's target rules.
          items:
            $ref: '#/components/schemas/BasePromotionRule'
        buy_rules:
          type: array
          description: The application method's buy rules.
          items:
            $ref: '#/components/schemas/BasePromotionRule'
    BaseCalculatedPriceSet:
      type: object
      description: The parent's calculated price.
      x-schemaName: BaseCalculatedPriceSet
      required:
        - id
        - calculated_amount
        - original_amount
        - currency_code
      properties:
        id:
          type: string
          title: id
          description: The calculated price's ID.
        is_calculated_price_price_list:
          type: boolean
          title: is_calculated_price_price_list
          description: The calculated price's is calculated price price list.
        is_calculated_price_tax_inclusive:
          type: boolean
          title: is_calculated_price_tax_inclusive
          description: The calculated price's is calculated price tax inclusive.
        calculated_amount:
          type: number
          title: calculated_amount
          description: The calculated price's calculated amount.
        calculated_amount_with_tax:
          type: number
          title: calculated_amount_with_tax
          description: The calculated price's calculated amount with tax.
        calculated_amount_without_tax:
          type: number
          title: calculated_amount_without_tax
          description: The calculated price's calculated amount without tax.
        is_original_price_price_list:
          type: boolean
          title: is_original_price_price_list
          description: The calculated price's is original price price list.
        is_original_price_tax_inclusive:
          type: boolean
          title: is_original_price_tax_inclusive
          description: The calculated price's is original price tax inclusive.
        original_amount:
          type: number
          title: original_amount
          description: The calculated price's original amount.
        currency_code:
          type: string
          title: currency_code
          description: The calculated price's currency code.
        calculated_price:
          type: object
          description: The calculated price's details.
        original_price:
          type: object
          description: The calculated price's original price.
    BaseCapture:
      type: object
      description: The capture's captures.
      x-schemaName: BaseCapture
    BaseCart:
      type: object
      description: The item's cart.
      x-schemaName: BaseCart
    BaseCartAddress:
      type: object
      description: The parent's billing address.
      x-schemaName: BaseCartAddress
      required:
        - id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The billing address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The billing address's customer id.
        first_name:
          type: string
          title: first_name
          description: The billing address's first name.
        last_name:
          type: string
          title: last_name
          description: The billing address's last name.
        phone:
          type: string
          title: phone
          description: The billing address's phone.
        company:
          type: string
          title: company
          description: The billing address's company.
        address_1:
          type: string
          title: address_1
          description: The billing address's address 1.
        address_2:
          type: string
          title: address_2
          description: The billing address's address 2.
        city:
          type: string
          title: city
          description: The billing address's city.
        country_code:
          type: string
          title: country_code
          description: The billing address's country code.
        province:
          type: string
          title: province
          description: The billing address's province.
        postal_code:
          type: string
          title: postal_code
          description: The billing address's postal code.
        metadata:
          type: object
          description: The billing address's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The billing address's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The billing address's updated at.
    BaseCartLineItem:
      type: object
      description: The item's items.
      x-schemaName: BaseCartLineItem
      required:
        - id
        - title
        - quantity
        - requires_shipping
        - is_discountable
        - is_tax_inclusive
        - unit_price
        - cart
        - cart_id
        - original_total
        - original_subtotal
        - original_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
      properties:
        id:
          type: string
          title: id
          description: The item's ID.
        title:
          type: string
          title: title
          description: The item's title.
        subtitle:
          type: string
          title: subtitle
          description: The item's subtitle.
        thumbnail:
          type: string
          title: thumbnail
          description: The item's thumbnail.
        quantity:
          oneOf:
            - type: string
              title: quantity
              description: The item's quantity.
            - type: number
              title: quantity
              description: The item's quantity.
            - type: string
              title: quantity
              description: The item's quantity.
            - $ref: '#/components/schemas/IBigNumber'
        product:
          $ref: '#/components/schemas/BaseProduct'
        product_id:
          type: string
          title: product_id
          description: The item's product id.
        product_title:
          type: string
          title: product_title
          description: The item's product title.
        product_description:
          type: string
          title: product_description
          description: The item's product description.
        product_subtitle:
          type: string
          title: product_subtitle
          description: The item's product subtitle.
        product_type:
          type: string
          title: product_type
          description: The item's product type.
        product_collection:
          type: string
          title: product_collection
          description: The item's product collection.
        product_handle:
          type: string
          title: product_handle
          description: The item's product handle.
        variant:
          $ref: '#/components/schemas/BaseProductVariant'
        variant_id:
          type: string
          title: variant_id
          description: The item's variant id.
        variant_sku:
          type: string
          title: variant_sku
          description: The item's variant sku.
        variant_barcode:
          type: string
          title: variant_barcode
          description: The item's variant barcode.
        variant_title:
          type: string
          title: variant_title
          description: The item's variant title.
        variant_option_values:
          type: object
          description: The item's variant option values.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: The item's requires shipping.
        is_discountable:
          type: boolean
          title: is_discountable
          description: The item's is discountable.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The item's is tax inclusive.
        compare_at_unit_price:
          oneOf:
            - type: string
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - type: number
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - type: string
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - $ref: '#/components/schemas/IBigNumber'
        unit_price:
          oneOf:
            - type: string
              title: unit_price
              description: The item's unit price.
            - type: number
              title: unit_price
              description: The item's unit price.
            - type: string
              title: unit_price
              description: The item's unit price.
            - $ref: '#/components/schemas/IBigNumber'
        tax_lines:
          type: array
          description: The item's tax lines.
          items:
            $ref: '#/components/schemas/BaseLineItemTaxLine'
        adjustments:
          type: array
          description: The item's adjustments.
          items:
            $ref: '#/components/schemas/BaseLineItemAdjustment'
        cart:
          $ref: '#/components/schemas/BaseCart'
        cart_id:
          type: string
          title: cart_id
          description: The item's cart id.
        metadata:
          type: object
          description: The item's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The item's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The item's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The item's deleted at.
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The item's original total.
            - type: number
              title: original_total
              description: The item's original total.
            - type: string
              title: original_total
              description: The item's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The item's original subtotal.
            - type: number
              title: original_subtotal
              description: The item's original subtotal.
            - type: string
              title: original_subtotal
              description: The item's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The item's original tax total.
            - type: number
              title: original_tax_total
              description: The item's original tax total.
            - type: string
              title: original_tax_total
              description: The item's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        item_total:
          oneOf:
            - type: string
              title: item_total
              description: The item's item total.
            - type: number
              title: item_total
              description: The item's item total.
            - type: string
              title: item_total
              description: The item's item total.
            - $ref: '#/components/schemas/IBigNumber'
        item_subtotal:
          oneOf:
            - type: string
              title: item_subtotal
              description: The item's item subtotal.
            - type: number
              title: item_subtotal
              description: The item's item subtotal.
            - type: string
              title: item_subtotal
              description: The item's item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        item_tax_total:
          oneOf:
            - type: string
              title: item_tax_total
              description: The item's item tax total.
            - type: number
              title: item_tax_total
              description: The item's item tax total.
            - type: string
              title: item_tax_total
              description: The item's item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The item's total.
            - type: number
              title: total
              description: The item's total.
            - type: string
              title: total
              description: The item's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The item's subtotal.
            - type: number
              title: subtotal
              description: The item's subtotal.
            - type: string
              title: subtotal
              description: The item's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The item's tax total.
            - type: number
              title: tax_total
              description: The item's tax total.
            - type: string
              title: tax_total
              description: The item's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The item's discount total.
            - type: number
              title: discount_total
              description: The item's discount total.
            - type: string
              title: discount_total
              description: The item's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The item's discount tax total.
            - type: number
              title: discount_tax_total
              description: The item's discount tax total.
            - type: string
              title: discount_tax_total
              description: The item's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
    BaseCartShippingMethod:
      type: object
      description: The shipping method's shipping methods.
      x-schemaName: BaseCartShippingMethod
      required:
        - id
        - cart_id
        - name
        - amount
        - is_tax_inclusive
        - created_at
        - updated_at
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
      properties:
        id:
          type: string
          title: id
          description: The shipping method's ID.
        cart_id:
          type: string
          title: cart_id
          description: The shipping method's cart id.
        name:
          type: string
          title: name
          description: The shipping method's name.
        description:
          type: string
          title: description
          description: The shipping method's description.
        amount:
          oneOf:
            - type: string
              title: amount
              description: The shipping method's amount.
            - type: number
              title: amount
              description: The shipping method's amount.
            - type: string
              title: amount
              description: The shipping method's amount.
            - $ref: '#/components/schemas/IBigNumber'
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The shipping method's is tax inclusive.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The shipping method's shipping option id.
        data:
          type: object
          description: The shipping method's data.
        metadata:
          type: object
          description: The shipping method's metadata.
        tax_lines:
          type: array
          description: The shipping method's tax lines.
          items:
            $ref: '#/components/schemas/BaseShippingMethodTaxLine'
        adjustments:
          type: array
          description: The shipping method's adjustments.
          items:
            $ref: '#/components/schemas/BaseShippingMethodAdjustment'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The shipping method's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The shipping method's updated at.
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The shipping method's original total.
            - type: number
              title: original_total
              description: The shipping method's original total.
            - type: string
              title: original_total
              description: The shipping method's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The shipping method's original subtotal.
            - type: number
              title: original_subtotal
              description: The shipping method's original subtotal.
            - type: string
              title: original_subtotal
              description: The shipping method's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The shipping method's original tax total.
            - type: number
              title: original_tax_total
              description: The shipping method's original tax total.
            - type: string
              title: original_tax_total
              description: The shipping method's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The shipping method's total.
            - type: number
              title: total
              description: The shipping method's total.
            - type: string
              title: total
              description: The shipping method's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The shipping method's subtotal.
            - type: number
              title: subtotal
              description: The shipping method's subtotal.
            - type: string
              title: subtotal
              description: The shipping method's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The shipping method's tax total.
            - type: number
              title: tax_total
              description: The shipping method's tax total.
            - type: string
              title: tax_total
              description: The shipping method's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The shipping method's discount total.
            - type: number
              title: discount_total
              description: The shipping method's discount total.
            - type: string
              title: discount_total
              description: The shipping method's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - type: number
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - type: string
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
    BaseClaim:
      type: object
      description: The order change's claim.
      x-schemaName: BaseClaim
    BaseClaimItem:
      type: object
      description: The claim item's claim items.
      x-schemaName: BaseClaimItem
      required:
        - id
        - claim_id
        - order_id
        - item_id
        - quantity
        - reason
        - raw_quantity
      properties:
        id:
          type: string
          title: id
          description: The claim item's ID.
        claim_id:
          type: string
          title: claim_id
          description: The claim item's claim id.
        order_id:
          type: string
          title: order_id
          description: The claim item's order id.
        item_id:
          type: string
          title: item_id
          description: The claim item's item id.
        quantity:
          type: number
          title: quantity
          description: The claim item's quantity.
        reason:
          type: string
          description: The claim item's reason.
          enum:
            - missing_item
            - wrong_item
            - production_failure
            - other
        raw_quantity:
          type: object
          description: The claim item's raw quantity.
        metadata:
          type: object
          description: The claim item's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The claim item's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The claim item's updated at.
    BaseCollection:
      type: object
      description: The product's collection.
      x-schemaName: BaseCollection
    BaseCustomer:
      type: object
      description: The customer's details.
      x-schemaName: BaseCustomer
      required:
        - id
        - email
        - default_billing_address_id
        - default_shipping_address_id
        - company_name
        - first_name
        - last_name
        - addresses
      properties:
        id:
          type: string
          title: id
          description: The customer's ID.
        email:
          type: string
          title: email
          description: The customer's email.
          format: email
        default_billing_address_id:
          type: string
          title: default_billing_address_id
          description: The ID of the address used as the default billing address.
        default_shipping_address_id:
          type: string
          title: default_shipping_address_id
          description: The ID of the address used as the default shipping address.
        company_name:
          type: string
          title: company_name
          description: The customer's company name.
        first_name:
          type: string
          title: first_name
          description: The customer's first name.
        last_name:
          type: string
          title: last_name
          description: The customer's last name.
        addresses:
          type: array
          description: The customer's addresses.
          items:
            $ref: '#/components/schemas/BaseCustomerAddress'
        phone:
          type: string
          title: phone
          description: The customer's phone.
        metadata:
          type: object
          description: The customer's metadata, used to store custom key-value pairs.
        created_by:
          type: string
          title: created_by
          description: The ID of the user that created this customer, if available.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The customer's creation date.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The customer's update date.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The customer's deletion date.
    BaseCustomerAddress:
      type: object
      description: The address's addresses.
      x-schemaName: BaseCustomerAddress
    BaseExchangeItem:
      type: object
      description: The additional item's additional items.
      x-schemaName: BaseExchangeItem
      required:
        - id
        - exchange_id
        - order_id
        - item_id
        - quantity
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The additional item's ID.
        exchange_id:
          type: string
          title: exchange_id
          description: The additional item's exchange id.
        order_id:
          type: string
          title: order_id
          description: The additional item's order id.
        item_id:
          type: string
          title: item_id
          description: The additional item's item id.
        quantity:
          type: number
          title: quantity
          description: The additional item's quantity.
        metadata:
          type: object
          description: The additional item's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The additional item's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The additional item's updated at.
    BaseFulfillmentProvider:
      type: object
      description: The shipping option's provider.
      x-schemaName: BaseFulfillmentProvider
      required:
        - id
        - is_enabled
      properties:
        id:
          type: string
          title: id
          description: The provider's ID.
        is_enabled:
          type: boolean
          title: is_enabled
          description: The provider's is enabled.
    BaseLineItemAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: BaseLineItemAdjustment
    BaseLineItemTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: BaseLineItemTaxLine
    BaseOrder:
      type: object
      description: The order change's order.
      x-schemaName: BaseOrder
    BaseOrderAddress:
      type: object
      description: The exchange's billing address.
      x-schemaName: BaseOrderAddress
      required:
        - id
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The billing address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The billing address's customer id.
        first_name:
          type: string
          title: first_name
          description: The billing address's first name.
        last_name:
          type: string
          title: last_name
          description: The billing address's last name.
        phone:
          type: string
          title: phone
          description: The billing address's phone.
        company:
          type: string
          title: company
          description: The billing address's company.
        address_1:
          type: string
          title: address_1
          description: The billing address's address 1.
        address_2:
          type: string
          title: address_2
          description: The billing address's address 2.
        city:
          type: string
          title: city
          description: The billing address's city.
        country_code:
          type: string
          title: country_code
          description: The billing address's country code.
        province:
          type: string
          title: province
          description: The billing address's province.
        postal_code:
          type: string
          title: postal_code
          description: The billing address's postal code.
        metadata:
          type: object
          description: The billing address's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The billing address's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The billing address's updated at.
    BaseOrderChange:
      type: object
      description: The order preview's order change.
      x-schemaName: BaseOrderChange
      required:
        - id
        - order_id
        - actions
        - status
        - requested_by
        - requested_at
        - confirmed_by
        - confirmed_at
        - declined_by
        - declined_reason
        - metadata
        - declined_at
        - canceled_by
        - canceled_at
        - created_at
        - updated_at
        - version
        - return_id
        - exchange_id
        - claim_id
        - order
        - return_order
        - exchange
        - claim
      properties:
        id:
          type: string
          title: id
          description: The order change's ID.
        order_id:
          type: string
          title: order_id
          description: The order change's order id.
        actions:
          type: array
          description: The order change's actions.
          items:
            $ref: '#/components/schemas/BaseOrderChangeAction'
        status:
          type: string
          title: status
          description: The order change's status.
        requested_by:
          type: string
          title: requested_by
          description: The order change's requested by.
        requested_at:
          oneOf:
            - type: string
              title: requested_at
              description: The order change's requested at.
            - type: string
              title: requested_at
              description: The order change's requested at.
              format: date-time
        confirmed_by:
          type: string
          title: confirmed_by
          description: The order change's confirmed by.
        confirmed_at:
          oneOf:
            - type: string
              title: confirmed_at
              description: The order change's confirmed at.
            - type: string
              title: confirmed_at
              description: The order change's confirmed at.
              format: date-time
        declined_by:
          type: string
          title: declined_by
          description: The order change's declined by.
        declined_reason:
          type: string
          title: declined_reason
          description: The order change's declined reason.
        metadata:
          type: object
          description: The order change's metadata.
        declined_at:
          oneOf:
            - type: string
              title: declined_at
              description: The order change's declined at.
            - type: string
              title: declined_at
              description: The order change's declined at.
              format: date-time
        canceled_by:
          type: string
          title: canceled_by
          description: The order change's canceled by.
        canceled_at:
          oneOf:
            - type: string
              title: canceled_at
              description: The order change's canceled at.
            - type: string
              title: canceled_at
              description: The order change's canceled at.
              format: date-time
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The order change's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The order change's updated at.
        version:
          type: number
          title: version
          description: The order change's version.
        change_type:
          type: string
          description: The order change's change type.
          enum:
            - return
            - exchange
            - claim
            - edit
            - return_request
        return_id:
          type: string
          title: return_id
          description: The order change's return id.
        exchange_id:
          type: string
          title: exchange_id
          description: The order change's exchange id.
        claim_id:
          type: string
          title: claim_id
          description: The order change's claim id.
        order:
          $ref: '#/components/schemas/BaseOrder'
        return_order: {}
        exchange: {}
        claim:
          $ref: '#/components/schemas/BaseClaim'
    BaseOrderChangeAction:
      type: object
      description: The action's actions.
      x-schemaName: BaseOrderChangeAction
    BaseOrderFulfillment:
      type: object
      description: The fulfillment's fulfillments.
      x-schemaName: BaseOrderFulfillment
      required:
        - id
        - location_id
        - packed_at
        - shipped_at
        - delivered_at
        - canceled_at
        - data
        - provider_id
        - shipping_option_id
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The fulfillment's ID.
        location_id:
          type: string
          title: location_id
          description: The fulfillment's location id.
        packed_at:
          type: string
          title: packed_at
          description: The fulfillment's packed at.
          format: date-time
        shipped_at:
          type: string
          title: shipped_at
          description: The fulfillment's shipped at.
          format: date-time
        delivered_at:
          type: string
          title: delivered_at
          description: The fulfillment's delivered at.
          format: date-time
        canceled_at:
          type: string
          title: canceled_at
          description: The fulfillment's canceled at.
          format: date-time
        data:
          type: object
          description: The fulfillment's data.
        provider_id:
          type: string
          title: provider_id
          description: The fulfillment's provider id.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The fulfillment's shipping option id.
        metadata:
          type: object
          description: The fulfillment's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The fulfillment's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The fulfillment's updated at.
    BaseOrderItemDetail:
      type: object
      description: The item's detail.
      x-schemaName: BaseOrderItemDetail
    BaseOrderLineItem:
      type: object
      description: The item's items.
      x-schemaName: BaseOrderLineItem
      required:
        - id
        - title
        - subtitle
        - thumbnail
        - variant_id
        - product_id
        - product_title
        - product_description
        - product_subtitle
        - product_type
        - product_collection
        - product_handle
        - variant_sku
        - variant_barcode
        - variant_title
        - variant_option_values
        - requires_shipping
        - is_discountable
        - is_tax_inclusive
        - unit_price
        - quantity
        - detail
        - created_at
        - updated_at
        - metadata
        - original_total
        - original_subtotal
        - original_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - refundable_total
        - refundable_total_per_unit
      properties:
        id:
          type: string
          title: id
          description: The item's ID.
        title:
          type: string
          title: title
          description: The item's title.
        subtitle:
          type: string
          title: subtitle
          description: The item's subtitle.
        thumbnail:
          type: string
          title: thumbnail
          description: The item's thumbnail.
        variant:
          $ref: '#/components/schemas/BaseProductVariant'
        variant_id:
          type: string
          title: variant_id
          description: The item's variant id.
        product:
          $ref: '#/components/schemas/BaseProduct'
        product_id:
          type: string
          title: product_id
          description: The item's product id.
        product_title:
          type: string
          title: product_title
          description: The item's product title.
        product_description:
          type: string
          title: product_description
          description: The item's product description.
        product_subtitle:
          type: string
          title: product_subtitle
          description: The item's product subtitle.
        product_type:
          type: string
          title: product_type
          description: The item's product type.
        product_collection:
          type: string
          title: product_collection
          description: The item's product collection.
        product_handle:
          type: string
          title: product_handle
          description: The item's product handle.
        variant_sku:
          type: string
          title: variant_sku
          description: The item's variant sku.
        variant_barcode:
          type: string
          title: variant_barcode
          description: The item's variant barcode.
        variant_title:
          type: string
          title: variant_title
          description: The item's variant title.
        variant_option_values:
          type: object
          description: The item's variant option values.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: The item's requires shipping.
        is_discountable:
          type: boolean
          title: is_discountable
          description: The item's is discountable.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The item's is tax inclusive.
        compare_at_unit_price:
          type: number
          title: compare_at_unit_price
          description: The item's compare at unit price.
        unit_price:
          type: number
          title: unit_price
          description: The item's unit price.
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        tax_lines:
          type: array
          description: The item's tax lines.
          items:
            $ref: '#/components/schemas/BaseOrderLineItemTaxLine'
        adjustments:
          type: array
          description: The item's adjustments.
          items:
            $ref: '#/components/schemas/BaseOrderLineItemAdjustment'
        detail:
          $ref: '#/components/schemas/BaseOrderItemDetail'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The item's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The item's updated at.
        metadata:
          type: object
          description: The item's metadata.
        original_total:
          type: number
          title: original_total
          description: The item's original total.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The item's original subtotal.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The item's original tax total.
        item_total:
          type: number
          title: item_total
          description: The item's item total.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The item's item subtotal.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The item's item tax total.
        total:
          type: number
          title: total
          description: The item's total.
        subtotal:
          type: number
          title: subtotal
          description: The item's subtotal.
        tax_total:
          type: number
          title: tax_total
          description: The item's tax total.
        discount_total:
          type: number
          title: discount_total
          description: The item's discount total.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The item's discount tax total.
        refundable_total:
          type: number
          title: refundable_total
          description: The item's refundable total.
        refundable_total_per_unit:
          type: number
          title: refundable_total_per_unit
          description: The item's refundable total per unit.
    BaseOrderLineItemAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: BaseOrderLineItemAdjustment
    BaseOrderLineItemTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: BaseOrderLineItemTaxLine
    BaseOrderShippingMethod:
      type: object
      description: The shipping method's shipping methods.
      x-schemaName: BaseOrderShippingMethod
      required:
        - id
        - order_id
        - name
        - amount
        - is_tax_inclusive
        - shipping_option_id
        - data
        - metadata
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The shipping method's ID.
        order_id:
          type: string
          title: order_id
          description: The shipping method's order id.
        name:
          type: string
          title: name
          description: The shipping method's name.
        description:
          type: string
          title: description
          description: The shipping method's description.
        amount:
          type: number
          title: amount
          description: The shipping method's amount.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The shipping method's is tax inclusive.
        shipping_option_id:
          type: string
          title: shipping_option_id
          description: The shipping method's shipping option id.
        data:
          type: object
          description: The shipping method's data.
        metadata:
          type: object
          description: The shipping method's metadata.
        tax_lines:
          type: array
          description: The shipping method's tax lines.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethodTaxLine'
        adjustments:
          type: array
          description: The shipping method's adjustments.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethodAdjustment'
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The shipping method's original total.
            - type: number
              title: original_total
              description: The shipping method's original total.
            - type: string
              title: original_total
              description: The shipping method's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The shipping method's original subtotal.
            - type: number
              title: original_subtotal
              description: The shipping method's original subtotal.
            - type: string
              title: original_subtotal
              description: The shipping method's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The shipping method's original tax total.
            - type: number
              title: original_tax_total
              description: The shipping method's original tax total.
            - type: string
              title: original_tax_total
              description: The shipping method's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The shipping method's total.
            - type: number
              title: total
              description: The shipping method's total.
            - type: string
              title: total
              description: The shipping method's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The shipping method's subtotal.
            - type: number
              title: subtotal
              description: The shipping method's subtotal.
            - type: string
              title: subtotal
              description: The shipping method's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The shipping method's tax total.
            - type: number
              title: tax_total
              description: The shipping method's tax total.
            - type: string
              title: tax_total
              description: The shipping method's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The shipping method's discount total.
            - type: number
              title: discount_total
              description: The shipping method's discount total.
            - type: string
              title: discount_total
              description: The shipping method's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - type: number
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - type: string
              title: discount_tax_total
              description: The shipping method's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The shipping method's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The shipping method's updated at.
    BaseOrderShippingMethodAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: BaseOrderShippingMethodAdjustment
    BaseOrderShippingMethodTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: BaseOrderShippingMethodTaxLine
    BaseOrderSummary:
      type: object
      description: The order's summary.
      x-schemaName: BaseOrderSummary
      required:
        - total
        - subtotal
        - total_tax
        - ordered_total
        - fulfilled_total
        - returned_total
        - return_request_total
        - write_off_total
        - projected_total
        - net_total
        - net_subtotal
        - net_total_tax
        - balance
        - paid_total
        - refunded_total
      properties:
        total:
          type: number
          title: total
          description: The summary's total.
        subtotal:
          type: number
          title: subtotal
          description: The summary's subtotal.
        total_tax:
          type: number
          title: total_tax
          description: The summary's total tax.
        ordered_total:
          type: number
          title: ordered_total
          description: The summary's ordered total.
        fulfilled_total:
          type: number
          title: fulfilled_total
          description: The summary's fulfilled total.
        returned_total:
          type: number
          title: returned_total
          description: The summary's returned total.
        return_request_total:
          type: number
          title: return_request_total
          description: The summary's return request total.
        write_off_total:
          type: number
          title: write_off_total
          description: The summary's write off total.
        projected_total:
          type: number
          title: projected_total
          description: The summary's projected total.
        net_total:
          type: number
          title: net_total
          description: The summary's net total.
        net_subtotal:
          type: number
          title: net_subtotal
          description: The summary's net subtotal.
        net_total_tax:
          type: number
          title: net_total_tax
          description: The summary's net total tax.
        balance:
          type: number
          title: balance
          description: The summary's balance.
        paid_total:
          type: number
          title: paid_total
          description: The summary's paid total.
        refunded_total:
          type: number
          title: refunded_total
          description: The summary's refunded total.
    BaseOrderTransaction:
      type: object
      description: The transaction's transactions.
      x-schemaName: BaseOrderTransaction
      required:
        - id
        - order_id
        - amount
        - currency_code
        - reference
        - reference_id
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The transaction's ID.
        order_id:
          type: string
          title: order_id
          description: The transaction's order id.
        amount:
          type: number
          title: amount
          description: The transaction's amount.
        currency_code:
          type: string
          title: currency_code
          description: The transaction's currency code.
        reference:
          type: string
          title: reference
          description: The transaction's reference.
        reference_id:
          type: string
          title: reference_id
          description: The transaction's reference id.
        metadata:
          type: object
          description: The transaction's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The transaction's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The transaction's updated at.
    BasePayment:
      type: object
      description: The payment's payments.
      x-schemaName: BasePayment
    BasePaymentCollection:
      type: object
      description: The payment collection's payment collections.
      x-schemaName: BasePaymentCollection
      required:
        - id
        - currency_code
        - region_id
        - amount
        - status
        - payment_providers
      properties:
        id:
          type: string
          title: id
          description: The payment collection's ID.
        currency_code:
          type: string
          title: currency_code
          description: The payment collection's currency code.
        region_id:
          type: string
          title: region_id
          description: The payment collection's region id.
        amount:
          oneOf:
            - type: string
              title: amount
              description: The payment collection's amount.
            - type: number
              title: amount
              description: The payment collection's amount.
            - type: string
              title: amount
              description: The payment collection's amount.
            - $ref: '#/components/schemas/IBigNumber'
        authorized_amount:
          oneOf:
            - type: string
              title: authorized_amount
              description: The payment collection's authorized amount.
            - type: number
              title: authorized_amount
              description: The payment collection's authorized amount.
            - type: string
              title: authorized_amount
              description: The payment collection's authorized amount.
            - $ref: '#/components/schemas/IBigNumber'
        captured_amount:
          oneOf:
            - type: string
              title: captured_amount
              description: The payment collection's captured amount.
            - type: number
              title: captured_amount
              description: The payment collection's captured amount.
            - type: string
              title: captured_amount
              description: The payment collection's captured amount.
            - $ref: '#/components/schemas/IBigNumber'
        refunded_amount:
          oneOf:
            - type: string
              title: refunded_amount
              description: The payment collection's refunded amount.
            - type: number
              title: refunded_amount
              description: The payment collection's refunded amount.
            - type: string
              title: refunded_amount
              description: The payment collection's refunded amount.
            - $ref: '#/components/schemas/IBigNumber'
        completed_at:
          oneOf:
            - type: string
              title: completed_at
              description: The payment collection's completed at.
            - type: string
              title: completed_at
              description: The payment collection's completed at.
              format: date-time
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The payment collection's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The payment collection's updated at.
        metadata:
          type: object
          description: The payment collection's metadata.
        status:
          type: string
          description: The payment collection's status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
        payment_providers:
          type: array
          description: The payment collection's payment providers.
          items:
            $ref: '#/components/schemas/BasePaymentProvider'
        payment_sessions:
          type: array
          description: The payment collection's payment sessions.
          items:
            $ref: '#/components/schemas/BasePaymentSession'
        payments:
          type: array
          description: The payment collection's payments.
          items:
            $ref: '#/components/schemas/BasePayment'
    BasePaymentProvider:
      type: object
      description: The payment provider's payment providers.
      x-schemaName: BasePaymentProvider
    BasePaymentSession:
      type: object
      description: The payment session's payment sessions.
      x-schemaName: BasePaymentSession
    BaseProduct:
      type: object
      description: The parent's product.
      x-schemaName: BaseProduct
      required:
        - id
        - title
        - handle
        - subtitle
        - description
        - is_giftcard
        - status
        - thumbnail
        - width
        - weight
        - length
        - height
        - origin_country
        - hs_code
        - mid_code
        - material
        - collection_id
        - type_id
        - variants
        - options
        - images
        - discountable
        - external_id
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          type: string
          title: id
          description: The product's ID.
        title:
          type: string
          title: title
          description: The product's title.
        handle:
          type: string
          title: handle
          description: The product's handle.
        subtitle:
          type: string
          title: subtitle
          description: The product's subtitle.
        description:
          type: string
          title: description
          description: The product's description.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: The product's is giftcard.
        status:
          type: string
          description: The product's status.
          enum:
            - draft
            - proposed
            - published
            - rejected
        thumbnail:
          type: string
          title: thumbnail
          description: The product's thumbnail.
        width:
          type: number
          title: width
          description: The product's width.
        weight:
          type: number
          title: weight
          description: The product's weight.
        length:
          type: number
          title: length
          description: The product's length.
        height:
          type: number
          title: height
          description: The product's height.
        origin_country:
          type: string
          title: origin_country
          description: The product's origin country.
        hs_code:
          type: string
          title: hs_code
          description: The product's hs code.
        mid_code:
          type: string
          title: mid_code
          description: The product's mid code.
        material:
          type: string
          title: material
          description: The product's material.
        collection:
          $ref: '#/components/schemas/BaseCollection'
        collection_id:
          type: string
          title: collection_id
          description: The product's collection id.
        categories:
          type: array
          description: The product's categories.
          items:
            $ref: '#/components/schemas/BaseProductCategory'
        type:
          type: object
        type_id:
          type: string
          title: type_id
          description: The product's type id.
        tags:
          type: array
          description: The product's tags.
          items:
            $ref: '#/components/schemas/BaseProductTag'
        variants:
          type: array
          description: The product's variants.
          items:
            $ref: '#/components/schemas/BaseProductVariant'
        options:
          type: array
          description: The product's options.
          items:
            $ref: '#/components/schemas/BaseProductOption'
        images:
          type: array
          description: The product's images.
          items:
            $ref: '#/components/schemas/BaseProductImage'
        discountable:
          type: boolean
          title: discountable
          description: The product's discountable.
        external_id:
          type: string
          title: external_id
          description: The product's external id.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The product's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The product's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The product's deleted at.
        metadata:
          type: object
          description: The product's metadata.
    BaseProductCategory:
      type: object
      description: The category's categories.
      x-schemaName: BaseProductCategory
    BaseProductImage:
      type: object
      description: The image's images.
      x-schemaName: BaseProductImage
    BaseProductOption:
      type: object
      description: The option's options.
      x-schemaName: BaseProductOption
    BaseProductOptionValue:
      type: object
      description: The option's options.
      x-schemaName: BaseProductOptionValue
      required:
        - id
        - value
      properties:
        id:
          type: string
          title: id
          description: The option's ID.
        value:
          type: string
          title: value
          description: The option's value.
        option:
          $ref: '#/components/schemas/BaseProductOption'
        option_id:
          type: string
          title: option_id
          description: The option's option id.
        metadata:
          type: object
          description: The option's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The option's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The option's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The option's deleted at.
    BaseProductTag:
      type: object
      description: The tag's tags.
      x-schemaName: BaseProductTag
    BaseProductVariant:
      type: object
      description: The variant's variants.
      x-schemaName: BaseProductVariant
    BasePromotion:
      type: object
      description: The application method's promotion.
      x-schemaName: BasePromotion
    BasePromotionRule:
      type: object
      description: The rule's rules.
      x-schemaName: BasePromotionRule
      required:
        - id
        - values
      properties:
        id:
          type: string
          title: id
          description: The rule's ID.
        description:
          type: string
          title: description
          description: The rule's description.
        attribute:
          type: string
          title: attribute
          description: The rule's attribute.
        operator:
          type: string
          description: The rule's operator.
          enum:
            - gt
            - lt
            - eq
            - ne
            - in
            - lte
            - gte
        values:
          type: array
          description: The rule's values.
          items:
            $ref: '#/components/schemas/BasePromotionRuleValue'
    BasePromotionRuleValue:
      type: object
      description: The value's values.
      x-schemaName: BasePromotionRuleValue
      required:
        - id
      properties:
        id:
          type: string
          title: id
          description: The value's ID.
        value:
          type: string
          title: value
          description: The value's details.
    BaseRefund:
      type: object
      description: The refund's refunds.
      x-schemaName: BaseRefund
    BaseRegion:
      type: object
      description: The parent's region.
      x-schemaName: BaseRegion
      required:
        - id
        - name
        - currency_code
      properties:
        id:
          type: string
          title: id
          description: The region's ID.
        name:
          type: string
          title: name
          description: The region's name.
        currency_code:
          type: string
          title: currency_code
          description: The region's currency code.
        automatic_taxes:
          type: boolean
          title: automatic_taxes
          description: The region's automatic taxes.
        countries:
          type: array
          description: The region's countries.
          items:
            $ref: '#/components/schemas/BaseRegionCountry'
        payment_providers:
          type: array
          description: The region's payment providers.
          items:
            $ref: '#/components/schemas/AdminPaymentProvider'
        metadata:
          type: object
          description: The region's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The region's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The region's updated at.
    BaseRegionCountry:
      type: object
      description: The country's countries.
      x-schemaName: BaseRegionCountry
    BaseReturnItem:
      type: object
      description: The item's items.
      x-schemaName: BaseReturnItem
    BaseRuleOperatorOptions:
      type: object
      description: The operator's operators.
      x-schemaName: BaseRuleOperatorOptions
      required:
        - id
        - value
        - label
      properties:
        id:
          type: string
          title: id
          description: The operator's ID.
        value:
          type: string
          title: value
          description: The operator's value.
        label:
          type: string
          title: label
          description: The operator's label.
    BaseShippingMethodAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: BaseShippingMethodAdjustment
    BaseShippingMethodTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: BaseShippingMethodTaxLine
    CampaignResponse:
      type: object
      description: The campaign's details.
      x-schemaName: CampaignResponse
      required:
        - id
        - name
        - description
        - currency
        - campaign_identifier
        - starts_at
        - ends_at
        - budget
      properties:
        id:
          type: string
          title: id
          description: The campaign's ID.
        name:
          type: string
          title: name
          description: The campaign's name.
        description:
          type: string
          title: description
          description: The campaign's description.
        currency:
          type: string
          title: currency
          description: The campaign's currency.
        campaign_identifier:
          type: string
          title: campaign_identifier
          description: The campaign's campaign identifier.
        starts_at:
          type: string
          title: starts_at
          description: The campaign's starts at.
        ends_at:
          type: string
          title: ends_at
          description: The campaign's ends at.
        budget:
          type: object
          description: The campaign's budget.
          required:
            - id
            - type
            - currency_code
            - limit
            - used
          properties:
            id:
              type: string
              title: id
              description: The budget's ID.
            type:
              type: string
              enum:
                - spend
                - usage
            currency_code:
              type: string
              title: currency_code
              description: The budget's currency code.
            limit:
              type: number
              title: limit
              description: The budget's limit.
            used:
              type: number
              title: used
              description: The budget's used.
    CreateAddress:
      type: object
      description: The cart's shipping address.
      x-schemaName: CreateAddress
      properties:
        customer_id:
          type: string
          title: customer_id
          description: The shipping address's customer id.
        company:
          type: string
          title: company
          description: The shipping address's company.
        first_name:
          type: string
          title: first_name
          description: The shipping address's first name.
        last_name:
          type: string
          title: last_name
          description: The shipping address's last name.
        address_1:
          type: string
          title: address_1
          description: The shipping address's address 1.
        address_2:
          type: string
          title: address_2
          description: The shipping address's address 2.
        city:
          type: string
          title: city
          description: The shipping address's city.
        country_code:
          type: string
          title: country_code
          description: The shipping address's country code.
        province:
          type: string
          title: province
          description: The shipping address's province.
        postal_code:
          type: string
          title: postal_code
          description: The shipping address's postal code.
        phone:
          type: string
          title: phone
          description: The shipping address's phone.
        metadata:
          type: object
          description: The shipping address's metadata.
    CreateCartAddress:
      type: object
      description: The cart's billing address.
      x-schemaName: CreateCartAddress
      properties:
        first_name:
          type: string
          title: first_name
          description: The billing address's first name.
        last_name:
          type: string
          title: last_name
          description: The billing address's last name.
        phone:
          type: string
          title: phone
          description: The billing address's phone.
        company:
          type: string
          title: company
          description: The billing address's company.
        address_1:
          type: string
          title: address_1
          description: The billing address's address 1.
        address_2:
          type: string
          title: address_2
          description: The billing address's address 2.
        city:
          type: string
          title: city
          description: The billing address's city.
        country_code:
          type: string
          title: country_code
          description: The billing address's country code.
        province:
          type: string
          title: province
          description: The billing address's province.
        postal_code:
          type: string
          title: postal_code
          description: The billing address's postal code.
        metadata:
          type: object
          description: The billing address's metadata.
    CreateCartCreateLineItem:
      type: object
      description: The item's items.
      x-schemaName: CreateCartCreateLineItem
      required:
        - quantity
        - variant_id
      properties:
        quantity:
          type: string
          title: quantity
          description: The item's quantity.
        variant_id:
          type: string
          title: variant_id
          description: The item's variant id.
        title:
          type: string
          title: title
          description: The item's title.
        subtitle:
          type: string
          title: subtitle
          description: The item's subtitle.
        thumbnail:
          type: string
          title: thumbnail
          description: The item's thumbnail.
        product_id:
          type: string
          title: product_id
          description: The item's product id.
        product_title:
          type: string
          title: product_title
          description: The item's product title.
        product_description:
          type: string
          title: product_description
          description: The item's product description.
        product_subtitle:
          type: string
          title: product_subtitle
          description: The item's product subtitle.
        product_type:
          type: string
          title: product_type
          description: The item's product type.
        product_collection:
          type: string
          title: product_collection
          description: The item's product collection.
        product_handle:
          type: string
          title: product_handle
          description: The item's product handle.
        variant_sku:
          type: string
          title: variant_sku
          description: The item's variant sku.
        variant_barcode:
          type: string
          title: variant_barcode
          description: The item's variant barcode.
        variant_title:
          type: string
          title: variant_title
          description: The item's variant title.
        variant_option_values:
          type: object
          description: The item's variant option values.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: The item's requires shipping.
        is_discountable:
          type: boolean
          title: is_discountable
          description: The item's is discountable.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The item's is tax inclusive.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: The item's is giftcard.
        compare_at_unit_price:
          type: string
          title: compare_at_unit_price
          description: The item's compare at unit price.
        unit_price:
          type: string
          title: unit_price
          description: The item's unit price.
        metadata:
          type: object
          description: The item's metadata.
    CreateCartWorkflowInput:
      type: object
      description: SUMMARY
      x-schemaName: CreateCartWorkflowInput
      properties:
        region_id:
          type: string
          title: region_id
          description: The cart's region id.
        customer_id:
          type: string
          title: customer_id
          description: The cart's customer id.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The cart's sales channel id.
        email:
          type: string
          title: email
          description: The cart's email.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The cart's currency code.
        shipping_address_id:
          type: string
          title: shipping_address_id
          description: The cart's shipping address id.
        billing_address_id:
          type: string
          title: billing_address_id
          description: The cart's billing address id.
        shipping_address:
          oneOf:
            - type: string
              title: shipping_address
              description: The cart's shipping address.
            - $ref: '#/components/schemas/CreateCartAddress'
        billing_address:
          oneOf:
            - type: string
              title: billing_address
              description: The cart's billing address.
            - $ref: '#/components/schemas/CreateCartAddress'
        metadata:
          type: object
          description: The cart's metadata.
        items:
          type: array
          description: The cart's items.
          items:
            $ref: '#/components/schemas/CreateCartCreateLineItem'
        promo_codes:
          type: array
          description: The cart's promo codes.
          items:
            type: string
            title: promo_codes
            description: The promo code's promo codes.
    CreateOrderReturnReason:
      type: object
      description: SUMMARY
      x-schemaName: CreateOrderReturnReason
      required:
        - value
        - label
      properties:
        value:
          type: string
          title: value
          description: The return reason's value.
        label:
          type: string
          title: label
          description: The return reason's label.
        description:
          type: string
          title: description
          description: The return reason's description.
        parent_return_reason_id:
          type: string
          title: parent_return_reason_id
          description: The return reason's parent return reason id.
        metadata:
          type: object
          description: The return reason's metadata.
    CustomerGroupInCustomerFilters:
      type: object
      description: The customer's groups.
      x-schemaName: CustomerGroupInCustomerFilters
      required:
        - id
        - name
        - created_at
        - updated_at
        - deleted_at
      properties:
        id:
          oneOf:
            - type: string
              title: id
              description: The group's ID.
            - type: array
              description: The group's ID.
              items:
                type: string
                title: id
                description: The id's ID.
        name:
          oneOf:
            - type: string
              title: name
              description: The group's name.
            - type: array
              description: The group's name.
              items:
                type: string
                title: name
                description: The name's details.
        created_at:
          type: object
          description: The group's created at.
          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`).
        updated_at:
          type: object
          description: The group's updated at.
          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`).
        deleted_at:
          type: object
          description: The group's deleted at.
          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`).
    Error:
      title: Response Error
      type: object
      properties:
        code:
          type: string
          description: A slug code to indicate the type of the error.
          enum:
            - invalid_state_error
            - invalid_request_error
            - api_error
            - unknown_error
        message:
          type: string
          description: Description of the error that occurred.
          example: first_name must be a string
        type:
          type: string
          description: A slug indicating the type of the error.
          enum:
            - QueryRunnerAlreadyReleasedError
            - TransactionAlreadyStartedError
            - TransactionNotStartedError
            - conflict
            - unauthorized
            - payment_authorization_error
            - duplicate_error
            - not_allowed
            - invalid_data
            - not_found
            - database_error
            - unexpected_state
            - invalid_argument
            - unknown_error
    File:
      type: object
      description: The product's file.
      x-schemaName: File
      required:
        - lastModified
        - name
        - webkitRelativePath
        - size
        - type
        - arrayBuffer
        - stream
        - text
      properties:
        lastModified:
          type: number
          title: lastModified
          description: The file's lastmodified.
        name:
          type: string
          title: name
          description: The file's name.
        webkitRelativePath:
          type: string
          title: webkitRelativePath
          description: The file's webkitrelativepath.
        size:
          type: number
          title: size
          description: The file's size.
        type:
          type: string
          title: type
          description: The file's type.
        arrayBuffer:
          type: object
          description: The file's arraybuffer.
        slice:
          type: object
          description: The file's slice.
        stream:
          type: object
          description: The file's stream.
        text:
          type: object
          description: The file's text.
    FileList:
      type: object
      description: SUMMARY
      x-schemaName: FileList
      required:
        - length
        - item
        - __@iterator@258
      properties:
        length:
          type: number
          title: length
          description: The upload's length.
        item:
          type: object
          description: The upload's item.
        __@iterator@258:
          type: object
          description: The upload's   @iterator@258.
    IBigNumber:
      type: object
      description: The shipping method's discount tax total.
      x-schemaName: IBigNumber
    InventoryLevel:
      type: object
      description: The inventory level's inventory levels.
      x-schemaName: InventoryLevel
      required:
        - id
        - inventory_item_id
        - location_id
        - stocked_quantity
        - reserved_quantity
        - available_quantity
        - incoming_quantity
      properties:
        id:
          type: string
          title: id
          description: The inventory level's ID.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The inventory level's inventory item id.
        location_id:
          type: string
          title: location_id
          description: The inventory level's location id.
        stocked_quantity:
          type: number
          title: stocked_quantity
          description: The inventory level's stocked quantity.
        reserved_quantity:
          type: number
          title: reserved_quantity
          description: The inventory level's reserved quantity.
        available_quantity:
          type: number
          title: available_quantity
          description: The inventory level's available quantity.
        incoming_quantity:
          type: number
          title: incoming_quantity
          description: The inventory level's incoming quantity.
        metadata:
          type: object
          description: The inventory level's metadata.
    Order:
      type: object
      description: The transaction's order.
      x-schemaName: Order
    OrderAddress:
      type: object
      description: The order preview's billing address.
      x-schemaName: OrderAddress
      required:
        - id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The billing address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The billing address's customer id.
        first_name:
          type: string
          title: first_name
          description: The billing address's first name.
        last_name:
          type: string
          title: last_name
          description: The billing address's last name.
        phone:
          type: string
          title: phone
          description: The billing address's phone.
        company:
          type: string
          title: company
          description: The billing address's company.
        address_1:
          type: string
          title: address_1
          description: The billing address's address 1.
        address_2:
          type: string
          title: address_2
          description: The billing address's address 2.
        city:
          type: string
          title: city
          description: The billing address's city.
        country_code:
          type: string
          title: country_code
          description: The billing address's country code.
        province:
          type: string
          title: province
          description: The billing address's province.
        postal_code:
          type: string
          title: postal_code
          description: The billing address's postal code.
        metadata:
          type: object
          description: The billing address's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The billing address's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The billing address's updated at.
    OrderChange:
      type: object
      description: The order preview's order change.
      x-schemaName: OrderChange
      required:
        - id
        - version
        - order_id
        - return_id
        - exchange_id
        - claim_id
        - order
        - return_order
        - exchange
        - claim
        - actions
        - status
        - requested_by
        - requested_at
        - confirmed_by
        - confirmed_at
        - declined_by
        - declined_reason
        - metadata
        - declined_at
        - canceled_by
        - canceled_at
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The order change's ID.
        version:
          type: number
          title: version
          description: The order change's version.
        change_type:
          type: string
          description: The order change's change type.
          enum:
            - return
            - exchange
            - claim
            - edit
        order_id:
          type: string
          title: order_id
          description: The order change's order id.
        return_id:
          type: string
          title: return_id
          description: The order change's return id.
        exchange_id:
          type: string
          title: exchange_id
          description: The order change's exchange id.
        claim_id:
          type: string
          title: claim_id
          description: The order change's claim id.
        order:
          type: object
        return_order:
          $ref: '#/components/schemas/Return'
        exchange:
          $ref: '#/components/schemas/OrderExchange'
        claim:
          $ref: '#/components/schemas/OrderClaim'
        actions:
          type: array
          description: The order change's actions.
          items:
            $ref: '#/components/schemas/OrderChangeAction'
        status:
          type: string
          title: status
          description: The order change's status.
        requested_by:
          type: string
          title: requested_by
          description: The order change's requested by.
        requested_at:
          oneOf:
            - type: string
              title: requested_at
              description: The order change's requested at.
            - type: string
              title: requested_at
              description: The order change's requested at.
              format: date-time
        confirmed_by:
          type: string
          title: confirmed_by
          description: The order change's confirmed by.
        confirmed_at:
          oneOf:
            - type: string
              title: confirmed_at
              description: The order change's confirmed at.
            - type: string
              title: confirmed_at
              description: The order change's confirmed at.
              format: date-time
        declined_by:
          type: string
          title: declined_by
          description: The order change's declined by.
        declined_reason:
          type: string
          title: declined_reason
          description: The order change's declined reason.
        metadata:
          type: object
          description: The order change's metadata.
        declined_at:
          oneOf:
            - type: string
              title: declined_at
              description: The order change's declined at.
            - type: string
              title: declined_at
              description: The order change's declined at.
              format: date-time
        canceled_by:
          type: string
          title: canceled_by
          description: The order change's canceled by.
        canceled_at:
          oneOf:
            - type: string
              title: canceled_at
              description: The order change's canceled at.
            - type: string
              title: canceled_at
              description: The order change's canceled at.
              format: date-time
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The order change's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The order change's updated at.
    OrderChangeAction:
      type: object
      description: The action's actions.
      x-schemaName: OrderChangeAction
    OrderClaim:
      type: object
      description: The order change's claim.
      x-schemaName: OrderClaim
    OrderExchange:
      type: object
      description: The order change's exchange.
      x-schemaName: OrderExchange
    OrderItem:
      type: object
      description: The item's detail.
      x-schemaName: OrderItem
    OrderLineItemAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: OrderLineItemAdjustment
    OrderLineItemTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: OrderLineItemTaxLine
    OrderPreview:
      type: object
      description: The order edit's order preview.
      x-schemaName: OrderPreview
      required:
        - order_change
        - status
        - currency_code
        - version
        - id
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
        - raw_original_item_total
        - raw_original_item_subtotal
        - raw_original_item_tax_total
        - raw_item_total
        - raw_item_subtotal
        - raw_item_tax_total
        - raw_original_total
        - raw_original_subtotal
        - raw_original_tax_total
        - raw_total
        - raw_subtotal
        - raw_tax_total
        - raw_discount_total
        - raw_discount_tax_total
        - raw_gift_card_total
        - raw_gift_card_tax_total
        - raw_shipping_total
        - raw_shipping_subtotal
        - raw_shipping_tax_total
        - raw_original_shipping_total
        - raw_original_shipping_subtotal
        - raw_original_shipping_tax_total
      properties:
        order_change:
          $ref: '#/components/schemas/OrderChange'
        items:
          type: array
          description: The order preview's items.
          items:
            allOf:
              - type: object
                description: The item's items.
                x-schemaName: OrderLineItem
                required:
                  - id
                  - title
                  - requires_shipping
                  - is_discountable
                  - is_tax_inclusive
                  - unit_price
                  - raw_unit_price
                  - quantity
                  - raw_quantity
                  - detail
                  - created_at
                  - updated_at
                  - original_total
                  - original_subtotal
                  - original_tax_total
                  - item_total
                  - item_subtotal
                  - item_tax_total
                  - total
                  - subtotal
                  - tax_total
                  - discount_total
                  - discount_tax_total
                  - refundable_total
                  - refundable_total_per_unit
                  - raw_original_total
                  - raw_original_subtotal
                  - raw_original_tax_total
                  - raw_item_total
                  - raw_item_subtotal
                  - raw_item_tax_total
                  - raw_total
                  - raw_subtotal
                  - raw_tax_total
                  - raw_discount_total
                  - raw_discount_tax_total
                  - raw_refundable_total
                  - raw_refundable_total_per_unit
                properties:
                  id:
                    type: string
                    title: id
                    description: The item's ID.
                  title:
                    type: string
                    title: title
                    description: The item's title.
                  subtitle:
                    type: string
                    title: subtitle
                    description: The item's subtitle.
                  thumbnail:
                    type: string
                    title: thumbnail
                    description: The item's thumbnail.
                  variant_id:
                    type: string
                    title: variant_id
                    description: The item's variant id.
                  product_id:
                    type: string
                    title: product_id
                    description: The item's product id.
                  product_title:
                    type: string
                    title: product_title
                    description: The item's product title.
                  product_description:
                    type: string
                    title: product_description
                    description: The item's product description.
                  product_subtitle:
                    type: string
                    title: product_subtitle
                    description: The item's product subtitle.
                  product_type:
                    type: string
                    title: product_type
                    description: The item's product type.
                  product_collection:
                    type: string
                    title: product_collection
                    description: The item's product collection.
                  product_handle:
                    type: string
                    title: product_handle
                    description: The item's product handle.
                  variant_sku:
                    type: string
                    title: variant_sku
                    description: The item's variant sku.
                  variant_barcode:
                    type: string
                    title: variant_barcode
                    description: The item's variant barcode.
                  variant_title:
                    type: string
                    title: variant_title
                    description: The item's variant title.
                  variant_option_values:
                    type: object
                    description: The item's variant option values.
                  requires_shipping:
                    type: boolean
                    title: requires_shipping
                    description: The item's requires shipping.
                  is_discountable:
                    type: boolean
                    title: is_discountable
                    description: The item's is discountable.
                  is_tax_inclusive:
                    type: boolean
                    title: is_tax_inclusive
                    description: The item's is tax inclusive.
                  compare_at_unit_price:
                    type: number
                    title: compare_at_unit_price
                    description: The item's compare at unit price.
                  raw_compare_at_unit_price:
                    type: object
                    description: The item's raw compare at unit price.
                  unit_price:
                    type: number
                    title: unit_price
                    description: The item's unit price.
                  raw_unit_price:
                    type: object
                    description: The item's raw unit price.
                  quantity:
                    type: number
                    title: quantity
                    description: The item's quantity.
                  raw_quantity:
                    type: object
                    description: The item's raw quantity.
                  tax_lines:
                    type: array
                    description: The item's tax lines.
                    items:
                      $ref: '#/components/schemas/OrderLineItemTaxLine'
                  adjustments:
                    type: array
                    description: The item's adjustments.
                    items:
                      $ref: '#/components/schemas/OrderLineItemAdjustment'
                  detail:
                    $ref: '#/components/schemas/OrderItem'
                  created_at:
                    type: string
                    format: date-time
                    title: created_at
                    description: The item's created at.
                  updated_at:
                    type: string
                    format: date-time
                    title: updated_at
                    description: The item's updated at.
                  metadata:
                    type: object
                    description: The item's metadata.
                  original_total:
                    oneOf:
                      - type: string
                        title: original_total
                        description: The item's original total.
                      - type: number
                        title: original_total
                        description: The item's original total.
                      - type: string
                        title: original_total
                        description: The item's original total.
                      - $ref: '#/components/schemas/IBigNumber'
                  original_subtotal:
                    oneOf:
                      - type: string
                        title: original_subtotal
                        description: The item's original subtotal.
                      - type: number
                        title: original_subtotal
                        description: The item's original subtotal.
                      - type: string
                        title: original_subtotal
                        description: The item's original subtotal.
                      - $ref: '#/components/schemas/IBigNumber'
                  original_tax_total:
                    oneOf:
                      - type: string
                        title: original_tax_total
                        description: The item's original tax total.
                      - type: number
                        title: original_tax_total
                        description: The item's original tax total.
                      - type: string
                        title: original_tax_total
                        description: The item's original tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  item_total:
                    oneOf:
                      - type: string
                        title: item_total
                        description: The item's item total.
                      - type: number
                        title: item_total
                        description: The item's item total.
                      - type: string
                        title: item_total
                        description: The item's item total.
                      - $ref: '#/components/schemas/IBigNumber'
                  item_subtotal:
                    oneOf:
                      - type: string
                        title: item_subtotal
                        description: The item's item subtotal.
                      - type: number
                        title: item_subtotal
                        description: The item's item subtotal.
                      - type: string
                        title: item_subtotal
                        description: The item's item subtotal.
                      - $ref: '#/components/schemas/IBigNumber'
                  item_tax_total:
                    oneOf:
                      - type: string
                        title: item_tax_total
                        description: The item's item tax total.
                      - type: number
                        title: item_tax_total
                        description: The item's item tax total.
                      - type: string
                        title: item_tax_total
                        description: The item's item tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  total:
                    oneOf:
                      - type: string
                        title: total
                        description: The item's total.
                      - type: number
                        title: total
                        description: The item's total.
                      - type: string
                        title: total
                        description: The item's total.
                      - $ref: '#/components/schemas/IBigNumber'
                  subtotal:
                    oneOf:
                      - type: string
                        title: subtotal
                        description: The item's subtotal.
                      - type: number
                        title: subtotal
                        description: The item's subtotal.
                      - type: string
                        title: subtotal
                        description: The item's subtotal.
                      - $ref: '#/components/schemas/IBigNumber'
                  tax_total:
                    oneOf:
                      - type: string
                        title: tax_total
                        description: The item's tax total.
                      - type: number
                        title: tax_total
                        description: The item's tax total.
                      - type: string
                        title: tax_total
                        description: The item's tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  discount_total:
                    oneOf:
                      - type: string
                        title: discount_total
                        description: The item's discount total.
                      - type: number
                        title: discount_total
                        description: The item's discount total.
                      - type: string
                        title: discount_total
                        description: The item's discount total.
                      - $ref: '#/components/schemas/IBigNumber'
                  discount_tax_total:
                    oneOf:
                      - type: string
                        title: discount_tax_total
                        description: The item's discount tax total.
                      - type: number
                        title: discount_tax_total
                        description: The item's discount tax total.
                      - type: string
                        title: discount_tax_total
                        description: The item's discount tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  refundable_total:
                    oneOf:
                      - type: string
                        title: refundable_total
                        description: The item's refundable total.
                      - type: number
                        title: refundable_total
                        description: The item's refundable total.
                      - type: string
                        title: refundable_total
                        description: The item's refundable total.
                      - $ref: '#/components/schemas/IBigNumber'
                  refundable_total_per_unit:
                    oneOf:
                      - type: string
                        title: refundable_total_per_unit
                        description: The item's refundable total per unit.
                      - type: number
                        title: refundable_total_per_unit
                        description: The item's refundable total per unit.
                      - type: string
                        title: refundable_total_per_unit
                        description: The item's refundable total per unit.
                      - $ref: '#/components/schemas/IBigNumber'
                  raw_original_total:
                    type: object
                    description: The item's raw original total.
                  raw_original_subtotal:
                    type: object
                    description: The item's raw original subtotal.
                  raw_original_tax_total:
                    type: object
                    description: The item's raw original tax total.
                  raw_item_total:
                    type: object
                    description: The item's raw item total.
                  raw_item_subtotal:
                    type: object
                    description: The item's raw item subtotal.
                  raw_item_tax_total:
                    type: object
                    description: The item's raw item tax total.
                  raw_total:
                    type: object
                    description: The item's raw total.
                  raw_subtotal:
                    type: object
                    description: The item's raw subtotal.
                  raw_tax_total:
                    type: object
                    description: The item's raw tax total.
                  raw_discount_total:
                    type: object
                    description: The item's raw discount total.
                  raw_discount_tax_total:
                    type: object
                    description: The item's raw discount tax total.
                  raw_refundable_total:
                    type: object
                    description: The item's raw refundable total.
                  raw_refundable_total_per_unit:
                    type: object
                    description: The item's raw refundable total per unit.
              - type: object
                description: The item's items.
                properties:
                  actions:
                    type: array
                    description: The item's actions.
                    items:
                      type: object
                      description: The action's actions.
                      x-schemaName: OrderChangeAction
        shipping_methods:
          type: array
          description: The order preview's shipping methods.
          items:
            allOf:
              - type: object
                description: The shipping method's shipping methods.
                x-schemaName: OrderShippingMethod
                required:
                  - id
                  - order_id
                  - name
                  - amount
                  - raw_amount
                  - is_tax_inclusive
                  - created_at
                  - updated_at
                  - original_total
                  - original_subtotal
                  - original_tax_total
                  - total
                  - subtotal
                  - tax_total
                  - discount_total
                  - discount_tax_total
                  - raw_original_total
                  - raw_original_subtotal
                  - raw_original_tax_total
                  - raw_total
                  - raw_subtotal
                  - raw_tax_total
                  - raw_discount_total
                  - raw_discount_tax_total
                properties:
                  id:
                    type: string
                    title: id
                    description: The shipping method's ID.
                  order_id:
                    type: string
                    title: order_id
                    description: The shipping method's order id.
                  name:
                    type: string
                    title: name
                    description: The shipping method's name.
                  description:
                    type: string
                    title: description
                    description: The shipping method's description.
                  amount:
                    oneOf:
                      - type: string
                        title: amount
                        description: The shipping method's amount.
                      - type: number
                        title: amount
                        description: The shipping method's amount.
                      - type: string
                        title: amount
                        description: The shipping method's amount.
                      - $ref: '#/components/schemas/IBigNumber'
                  raw_amount:
                    type: object
                    description: The shipping method's raw amount.
                  is_tax_inclusive:
                    type: boolean
                    title: is_tax_inclusive
                    description: The shipping method's is tax inclusive.
                  shipping_option_id:
                    type: string
                    title: shipping_option_id
                    description: The shipping method's shipping option id.
                  data:
                    type: object
                    description: The shipping method's data.
                  metadata:
                    type: object
                    description: The shipping method's metadata.
                  tax_lines:
                    type: array
                    description: The shipping method's tax lines.
                    items:
                      $ref: '#/components/schemas/OrderShippingMethodTaxLine'
                  adjustments:
                    type: array
                    description: The shipping method's adjustments.
                    items:
                      $ref: '#/components/schemas/OrderShippingMethodAdjustment'
                  created_at:
                    type: string
                    format: date-time
                    title: created_at
                    description: The shipping method's created at.
                  updated_at:
                    type: string
                    format: date-time
                    title: updated_at
                    description: The shipping method's updated at.
                  original_total:
                    oneOf:
                      - type: string
                        title: original_total
                        description: The shipping method's original total.
                      - type: number
                        title: original_total
                        description: The shipping method's original total.
                      - type: string
                        title: original_total
                        description: The shipping method's original total.
                      - $ref: '#/components/schemas/IBigNumber'
                  original_subtotal:
                    oneOf:
                      - type: string
                        title: original_subtotal
                        description: The shipping method's original subtotal.
                      - type: number
                        title: original_subtotal
                        description: The shipping method's original subtotal.
                      - type: string
                        title: original_subtotal
                        description: The shipping method's original subtotal.
                      - $ref: '#/components/schemas/IBigNumber'
                  original_tax_total:
                    oneOf:
                      - type: string
                        title: original_tax_total
                        description: The shipping method's original tax total.
                      - type: number
                        title: original_tax_total
                        description: The shipping method's original tax total.
                      - type: string
                        title: original_tax_total
                        description: The shipping method's original tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  total:
                    oneOf:
                      - type: string
                        title: total
                        description: The shipping method's total.
                      - type: number
                        title: total
                        description: The shipping method's total.
                      - type: string
                        title: total
                        description: The shipping method's total.
                      - $ref: '#/components/schemas/IBigNumber'
                  subtotal:
                    oneOf:
                      - type: string
                        title: subtotal
                        description: The shipping method's subtotal.
                      - type: number
                        title: subtotal
                        description: The shipping method's subtotal.
                      - type: string
                        title: subtotal
                        description: The shipping method's subtotal.
                      - $ref: '#/components/schemas/IBigNumber'
                  tax_total:
                    oneOf:
                      - type: string
                        title: tax_total
                        description: The shipping method's tax total.
                      - type: number
                        title: tax_total
                        description: The shipping method's tax total.
                      - type: string
                        title: tax_total
                        description: The shipping method's tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  discount_total:
                    oneOf:
                      - type: string
                        title: discount_total
                        description: The shipping method's discount total.
                      - type: number
                        title: discount_total
                        description: The shipping method's discount total.
                      - type: string
                        title: discount_total
                        description: The shipping method's discount total.
                      - $ref: '#/components/schemas/IBigNumber'
                  discount_tax_total:
                    oneOf:
                      - type: string
                        title: discount_tax_total
                        description: The shipping method's discount tax total.
                      - type: number
                        title: discount_tax_total
                        description: The shipping method's discount tax total.
                      - type: string
                        title: discount_tax_total
                        description: The shipping method's discount tax total.
                      - $ref: '#/components/schemas/IBigNumber'
                  raw_original_total:
                    type: object
                    description: The shipping method's raw original total.
                  raw_original_subtotal:
                    type: object
                    description: The shipping method's raw original subtotal.
                  raw_original_tax_total:
                    type: object
                    description: The shipping method's raw original tax total.
                  raw_total:
                    type: object
                    description: The shipping method's raw total.
                  raw_subtotal:
                    type: object
                    description: The shipping method's raw subtotal.
                  raw_tax_total:
                    type: object
                    description: The shipping method's raw tax total.
                  raw_discount_total:
                    type: object
                    description: The shipping method's raw discount total.
                  raw_discount_tax_total:
                    type: object
                    description: The shipping method's raw discount tax total.
              - type: object
                description: The shipping method's shipping methods.
                properties:
                  actions:
                    type: array
                    description: The shipping method's actions.
                    items:
                      type: object
                      description: The action's actions.
                      x-schemaName: OrderChangeAction
        status:
          type: string
          description: The order preview's status.
          enum:
            - canceled
            - requires_action
            - pending
            - completed
            - draft
            - archived
        currency_code:
          type: string
          title: currency_code
          description: The order preview's currency code.
        version:
          type: number
          title: version
          description: The order preview's version.
        id:
          type: string
          title: id
          description: The order preview's ID.
        region_id:
          type: string
          title: region_id
          description: The order preview's region id.
        customer_id:
          type: string
          title: customer_id
          description: The order preview's customer id.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The order preview's sales channel id.
        email:
          type: string
          title: email
          description: The order preview's email.
          format: email
        shipping_address:
          $ref: '#/components/schemas/OrderAddress'
        billing_address:
          $ref: '#/components/schemas/OrderAddress'
        transactions:
          type: array
          description: The order preview's transactions.
          items:
            $ref: '#/components/schemas/OrderTransaction'
        summary:
          type: object
          description: The order preview's summary.
          required:
            - total
            - subtotal
            - total_tax
            - ordered_total
            - fulfilled_total
            - returned_total
            - return_request_total
            - write_off_total
            - projected_total
            - net_total
            - net_subtotal
            - net_total_tax
            - balance
            - paid_total
            - refunded_total
            - pending_difference
            - raw_pending_difference
          properties:
            total:
              oneOf:
                - type: string
                  title: total
                  description: The summary's total.
                - type: number
                  title: total
                  description: The summary's total.
                - type: string
                  title: total
                  description: The summary's total.
                - type: object
                  description: The summary's total.
                  x-schemaName: IBigNumber
            subtotal:
              oneOf:
                - type: string
                  title: subtotal
                  description: The summary's subtotal.
                - type: number
                  title: subtotal
                  description: The summary's subtotal.
                - type: string
                  title: subtotal
                  description: The summary's subtotal.
                - type: object
                  description: The summary's subtotal.
                  x-schemaName: IBigNumber
            total_tax:
              oneOf:
                - type: string
                  title: total_tax
                  description: The summary's total tax.
                - type: number
                  title: total_tax
                  description: The summary's total tax.
                - type: string
                  title: total_tax
                  description: The summary's total tax.
                - type: object
                  description: The summary's total tax.
                  x-schemaName: IBigNumber
            ordered_total:
              oneOf:
                - type: string
                  title: ordered_total
                  description: The summary's ordered total.
                - type: number
                  title: ordered_total
                  description: The summary's ordered total.
                - type: string
                  title: ordered_total
                  description: The summary's ordered total.
                - type: object
                  description: The summary's ordered total.
                  x-schemaName: IBigNumber
            fulfilled_total:
              oneOf:
                - type: string
                  title: fulfilled_total
                  description: The summary's fulfilled total.
                - type: number
                  title: fulfilled_total
                  description: The summary's fulfilled total.
                - type: string
                  title: fulfilled_total
                  description: The summary's fulfilled total.
                - type: object
                  description: The summary's fulfilled total.
                  x-schemaName: IBigNumber
            returned_total:
              oneOf:
                - type: string
                  title: returned_total
                  description: The summary's returned total.
                - type: number
                  title: returned_total
                  description: The summary's returned total.
                - type: string
                  title: returned_total
                  description: The summary's returned total.
                - type: object
                  description: The summary's returned total.
                  x-schemaName: IBigNumber
            return_request_total:
              oneOf:
                - type: string
                  title: return_request_total
                  description: The summary's return request total.
                - type: number
                  title: return_request_total
                  description: The summary's return request total.
                - type: string
                  title: return_request_total
                  description: The summary's return request total.
                - type: object
                  description: The summary's return request total.
                  x-schemaName: IBigNumber
            write_off_total:
              oneOf:
                - type: string
                  title: write_off_total
                  description: The summary's write off total.
                - type: number
                  title: write_off_total
                  description: The summary's write off total.
                - type: string
                  title: write_off_total
                  description: The summary's write off total.
                - type: object
                  description: The summary's write off total.
                  x-schemaName: IBigNumber
            projected_total:
              oneOf:
                - type: string
                  title: projected_total
                  description: The summary's projected total.
                - type: number
                  title: projected_total
                  description: The summary's projected total.
                - type: string
                  title: projected_total
                  description: The summary's projected total.
                - type: object
                  description: The summary's projected total.
                  x-schemaName: IBigNumber
            net_total:
              oneOf:
                - type: string
                  title: net_total
                  description: The summary's net total.
                - type: number
                  title: net_total
                  description: The summary's net total.
                - type: string
                  title: net_total
                  description: The summary's net total.
                - type: object
                  description: The summary's net total.
                  x-schemaName: IBigNumber
            net_subtotal:
              oneOf:
                - type: string
                  title: net_subtotal
                  description: The summary's net subtotal.
                - type: number
                  title: net_subtotal
                  description: The summary's net subtotal.
                - type: string
                  title: net_subtotal
                  description: The summary's net subtotal.
                - type: object
                  description: The summary's net subtotal.
                  x-schemaName: IBigNumber
            net_total_tax:
              oneOf:
                - type: string
                  title: net_total_tax
                  description: The summary's net total tax.
                - type: number
                  title: net_total_tax
                  description: The summary's net total tax.
                - type: string
                  title: net_total_tax
                  description: The summary's net total tax.
                - type: object
                  description: The summary's net total tax.
                  x-schemaName: IBigNumber
            balance:
              oneOf:
                - type: string
                  title: balance
                  description: The summary's balance.
                - type: number
                  title: balance
                  description: The summary's balance.
                - type: string
                  title: balance
                  description: The summary's balance.
                - type: object
                  description: The summary's balance.
                  x-schemaName: IBigNumber
            paid_total:
              oneOf:
                - type: string
                  title: paid_total
                  description: The summary's paid total.
                - type: number
                  title: paid_total
                  description: The summary's paid total.
                - type: string
                  title: paid_total
                  description: The summary's paid total.
                - type: object
                  description: The summary's paid total.
                  x-schemaName: IBigNumber
            refunded_total:
              oneOf:
                - type: string
                  title: refunded_total
                  description: The summary's refunded total.
                - type: number
                  title: refunded_total
                  description: The summary's refunded total.
                - type: string
                  title: refunded_total
                  description: The summary's refunded total.
                - type: object
                  description: The summary's refunded total.
                  x-schemaName: IBigNumber
            pending_difference:
              oneOf:
                - type: string
                  title: pending_difference
                  description: The summary's pending difference.
                - type: number
                  title: pending_difference
                  description: The summary's pending difference.
                - type: string
                  title: pending_difference
                  description: The summary's pending difference.
                - type: object
                  description: The summary's pending difference.
                  x-schemaName: IBigNumber
            raw_pending_difference:
              type: object
              description: The summary's raw pending difference.
        metadata:
          type: object
          description: The order preview's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The order preview's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The order preview's updated at.
        original_item_total:
          oneOf:
            - type: string
              title: original_item_total
              description: The order preview's original item total.
            - type: number
              title: original_item_total
              description: The order preview's original item total.
            - type: string
              title: original_item_total
              description: The order preview's original item total.
            - $ref: '#/components/schemas/IBigNumber'
        original_item_subtotal:
          oneOf:
            - type: string
              title: original_item_subtotal
              description: The order preview's original item subtotal.
            - type: number
              title: original_item_subtotal
              description: The order preview's original item subtotal.
            - type: string
              title: original_item_subtotal
              description: The order preview's original item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_item_tax_total:
          oneOf:
            - type: string
              title: original_item_tax_total
              description: The order preview's original item tax total.
            - type: number
              title: original_item_tax_total
              description: The order preview's original item tax total.
            - type: string
              title: original_item_tax_total
              description: The order preview's original item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        item_total:
          oneOf:
            - type: string
              title: item_total
              description: The order preview's item total.
            - type: number
              title: item_total
              description: The order preview's item total.
            - type: string
              title: item_total
              description: The order preview's item total.
            - $ref: '#/components/schemas/IBigNumber'
        item_subtotal:
          oneOf:
            - type: string
              title: item_subtotal
              description: The order preview's item subtotal.
            - type: number
              title: item_subtotal
              description: The order preview's item subtotal.
            - type: string
              title: item_subtotal
              description: The order preview's item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        item_tax_total:
          oneOf:
            - type: string
              title: item_tax_total
              description: The order preview's item tax total.
            - type: number
              title: item_tax_total
              description: The order preview's item tax total.
            - type: string
              title: item_tax_total
              description: The order preview's item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The order preview's original total.
            - type: number
              title: original_total
              description: The order preview's original total.
            - type: string
              title: original_total
              description: The order preview's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The order preview's original subtotal.
            - type: number
              title: original_subtotal
              description: The order preview's original subtotal.
            - type: string
              title: original_subtotal
              description: The order preview's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The order preview's original tax total.
            - type: number
              title: original_tax_total
              description: The order preview's original tax total.
            - type: string
              title: original_tax_total
              description: The order preview's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The order preview's total.
            - type: number
              title: total
              description: The order preview's total.
            - type: string
              title: total
              description: The order preview's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The order preview's subtotal.
            - type: number
              title: subtotal
              description: The order preview's subtotal.
            - type: string
              title: subtotal
              description: The order preview's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The order preview's tax total.
            - type: number
              title: tax_total
              description: The order preview's tax total.
            - type: string
              title: tax_total
              description: The order preview's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The order preview's discount total.
            - type: number
              title: discount_total
              description: The order preview's discount total.
            - type: string
              title: discount_total
              description: The order preview's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The order preview's discount tax total.
            - type: number
              title: discount_tax_total
              description: The order preview's discount tax total.
            - type: string
              title: discount_tax_total
              description: The order preview's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
        gift_card_total:
          oneOf:
            - type: string
              title: gift_card_total
              description: The order preview's gift card total.
            - type: number
              title: gift_card_total
              description: The order preview's gift card total.
            - type: string
              title: gift_card_total
              description: The order preview's gift card total.
            - $ref: '#/components/schemas/IBigNumber'
        gift_card_tax_total:
          oneOf:
            - type: string
              title: gift_card_tax_total
              description: The order preview's gift card tax total.
            - type: number
              title: gift_card_tax_total
              description: The order preview's gift card tax total.
            - type: string
              title: gift_card_tax_total
              description: The order preview's gift card tax total.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_total:
          oneOf:
            - type: string
              title: shipping_total
              description: The order preview's shipping total.
            - type: number
              title: shipping_total
              description: The order preview's shipping total.
            - type: string
              title: shipping_total
              description: The order preview's shipping total.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_subtotal:
          oneOf:
            - type: string
              title: shipping_subtotal
              description: The order preview's shipping subtotal.
            - type: number
              title: shipping_subtotal
              description: The order preview's shipping subtotal.
            - type: string
              title: shipping_subtotal
              description: The order preview's shipping subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_tax_total:
          oneOf:
            - type: string
              title: shipping_tax_total
              description: The order preview's shipping tax total.
            - type: number
              title: shipping_tax_total
              description: The order preview's shipping tax total.
            - type: string
              title: shipping_tax_total
              description: The order preview's shipping tax total.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_total:
          oneOf:
            - type: string
              title: original_shipping_total
              description: The order preview's original shipping total.
            - type: number
              title: original_shipping_total
              description: The order preview's original shipping total.
            - type: string
              title: original_shipping_total
              description: The order preview's original shipping total.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_subtotal:
          oneOf:
            - type: string
              title: original_shipping_subtotal
              description: The order preview's original shipping subtotal.
            - type: number
              title: original_shipping_subtotal
              description: The order preview's original shipping subtotal.
            - type: string
              title: original_shipping_subtotal
              description: The order preview's original shipping subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_tax_total:
          oneOf:
            - type: string
              title: original_shipping_tax_total
              description: The order preview's original shipping tax total.
            - type: number
              title: original_shipping_tax_total
              description: The order preview's original shipping tax total.
            - type: string
              title: original_shipping_tax_total
              description: The order preview's original shipping tax total.
            - $ref: '#/components/schemas/IBigNumber'
        canceled_at:
          oneOf:
            - type: string
              title: canceled_at
              description: The order preview's canceled at.
            - type: string
              title: canceled_at
              description: The order preview's canceled at.
              format: date-time
        raw_original_item_total:
          type: object
          description: The order preview's raw original item total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original item total's value.
                - type: number
                  title: value
                  description: The raw original item total's value.
        raw_original_item_subtotal:
          type: object
          description: The order preview's raw original item subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original item subtotal's value.
                - type: number
                  title: value
                  description: The raw original item subtotal's value.
        raw_original_item_tax_total:
          type: object
          description: The order preview's raw original item tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original item tax total's value.
                - type: number
                  title: value
                  description: The raw original item tax total's value.
        raw_item_total:
          type: object
          description: The order preview's raw item total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw item total's value.
                - type: number
                  title: value
                  description: The raw item total's value.
        raw_item_subtotal:
          type: object
          description: The order preview's raw item subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw item subtotal's value.
                - type: number
                  title: value
                  description: The raw item subtotal's value.
        raw_item_tax_total:
          type: object
          description: The order preview's raw item tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw item tax total's value.
                - type: number
                  title: value
                  description: The raw item tax total's value.
        raw_original_total:
          type: object
          description: The order preview's raw original total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original total's value.
                - type: number
                  title: value
                  description: The raw original total's value.
        raw_original_subtotal:
          type: object
          description: The order preview's raw original subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original subtotal's value.
                - type: number
                  title: value
                  description: The raw original subtotal's value.
        raw_original_tax_total:
          type: object
          description: The order preview's raw original tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original tax total's value.
                - type: number
                  title: value
                  description: The raw original tax total's value.
        raw_total:
          type: object
          description: The order preview's raw total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw total's value.
                - type: number
                  title: value
                  description: The raw total's value.
        raw_subtotal:
          type: object
          description: The order preview's raw subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw subtotal's value.
                - type: number
                  title: value
                  description: The raw subtotal's value.
        raw_tax_total:
          type: object
          description: The order preview's raw tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw tax total's value.
                - type: number
                  title: value
                  description: The raw tax total's value.
        raw_discount_total:
          type: object
          description: The order preview's raw discount total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw discount total's value.
                - type: number
                  title: value
                  description: The raw discount total's value.
        raw_discount_tax_total:
          type: object
          description: The order preview's raw discount tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw discount tax total's value.
                - type: number
                  title: value
                  description: The raw discount tax total's value.
        raw_gift_card_total:
          type: object
          description: The order preview's raw gift card total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw gift card total's value.
                - type: number
                  title: value
                  description: The raw gift card total's value.
        raw_gift_card_tax_total:
          type: object
          description: The order preview's raw gift card tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw gift card tax total's value.
                - type: number
                  title: value
                  description: The raw gift card tax total's value.
        raw_shipping_total:
          type: object
          description: The order preview's raw shipping total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw shipping total's value.
                - type: number
                  title: value
                  description: The raw shipping total's value.
        raw_shipping_subtotal:
          type: object
          description: The order preview's raw shipping subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw shipping subtotal's value.
                - type: number
                  title: value
                  description: The raw shipping subtotal's value.
        raw_shipping_tax_total:
          type: object
          description: The order preview's raw shipping tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw shipping tax total's value.
                - type: number
                  title: value
                  description: The raw shipping tax total's value.
        raw_original_shipping_total:
          type: object
          description: The order preview's raw original shipping total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original shipping total's value.
                - type: number
                  title: value
                  description: The raw original shipping total's value.
        raw_original_shipping_subtotal:
          type: object
          description: The order preview's raw original shipping subtotal.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original shipping subtotal's value.
                - type: number
                  title: value
                  description: The raw original shipping subtotal's value.
        raw_original_shipping_tax_total:
          type: object
          description: The order preview's raw original shipping tax total.
          required:
            - value
          properties:
            value:
              oneOf:
                - type: string
                  title: value
                  description: The raw original shipping tax total's value.
                - type: number
                  title: value
                  description: The raw original shipping tax total's value.
    OrderShippingMethodAdjustment:
      type: object
      description: The adjustment's adjustments.
      x-schemaName: OrderShippingMethodAdjustment
    OrderShippingMethodTaxLine:
      type: object
      description: The tax line's tax lines.
      x-schemaName: OrderShippingMethodTaxLine
    OrderTransaction:
      type: object
      description: The transaction's transactions.
      x-schemaName: OrderTransaction
      required:
        - id
        - order_id
        - order
        - amount
        - raw_amount
        - currency_code
        - reference
        - reference_id
        - created_at
        - updated_at
        - metadata
      properties:
        id:
          type: string
          title: id
          description: The transaction's ID.
        order_id:
          type: string
          title: order_id
          description: The transaction's order id.
        order:
          type: object
        amount:
          oneOf:
            - type: string
              title: amount
              description: The transaction's amount.
            - type: number
              title: amount
              description: The transaction's amount.
            - type: string
              title: amount
              description: The transaction's amount.
            - $ref: '#/components/schemas/IBigNumber'
        raw_amount:
          type: object
          description: The transaction's raw amount.
        currency_code:
          type: string
          title: currency_code
          description: The transaction's currency code.
        reference:
          type: string
          title: reference
          description: The transaction's reference.
        reference_id:
          type: string
          title: reference_id
          description: The transaction's reference id.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The transaction's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The transaction's updated at.
        metadata:
          type: object
          description: The transaction's metadata.
    RefundReasonResponse:
      type: object
      description: SUMMARY
      x-schemaName: RefundReasonResponse
      required:
        - refund_reason
      properties:
        refund_reason:
          $ref: '#/components/schemas/AdminRefundReason'
    ReservationResponse:
      type: object
      description: The reservation's details.
      x-schemaName: ReservationResponse
      required:
        - id
        - line_item_id
        - location_id
        - quantity
        - external_id
        - description
        - inventory_item_id
        - inventory_item
      properties:
        id:
          type: string
          title: id
          description: The reservation's ID.
        line_item_id:
          type: string
          title: line_item_id
          description: The reservation's line item id.
        location_id:
          type: string
          title: location_id
          description: The reservation's location id.
        quantity:
          type: string
          title: quantity
          description: The reservation's quantity.
        external_id:
          type: string
          title: external_id
          description: The reservation's external id.
        description:
          type: string
          title: description
          description: The reservation's description.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The reservation's inventory item id.
        inventory_item:
          type: object
          description: The reservation's inventory item.
        metadata:
          type: object
          description: The reservation's metadata.
        created_by:
          type: string
          title: created_by
          description: The reservation's created by.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The reservation's deleted at.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The reservation's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The reservation's updated at.
    Return:
      type: object
      description: The order change's return order.
      x-schemaName: Return
    StoreAddCartLineItem:
      type: object
      description: SUMMARY
      x-schemaName: StoreAddCartLineItem
      required:
        - variant_id
        - quantity
      properties:
        variant_id:
          type: string
          title: variant_id
          description: The cart's variant id.
        quantity:
          type: number
          title: quantity
          description: The cart's quantity.
        metadata:
          type: object
          description: The cart's metadata.
    StoreCalculateCartTaxes:
      type: object
      description: SUMMARY
      x-schemaName: StoreCalculateCartTaxes
      properties:
        fields:
          type: string
          title: fields
          description: The cart's fields.
    StoreCart:
      type: object
      description: The cart's parent.
      x-schemaName: StoreCart
      required:
        - id
        - currency_code
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        id:
          type: string
          title: id
          description: The parent's ID.
        region:
          $ref: '#/components/schemas/BaseRegion'
        region_id:
          type: string
          title: region_id
          description: The parent's region id.
        customer_id:
          type: string
          title: customer_id
          description: The parent's customer id.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The parent's sales channel id.
        email:
          type: string
          title: email
          description: The parent's email.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The parent's currency code.
        shipping_address:
          $ref: '#/components/schemas/BaseCartAddress'
        billing_address:
          $ref: '#/components/schemas/BaseCartAddress'
        items:
          type: array
          description: The parent's items.
          items:
            $ref: '#/components/schemas/BaseCartLineItem'
        shipping_methods:
          type: array
          description: The parent's shipping methods.
          items:
            $ref: '#/components/schemas/BaseCartShippingMethod'
        payment_collection:
          $ref: '#/components/schemas/BasePaymentCollection'
        metadata:
          type: object
          description: The parent's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The parent's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The parent's updated at.
        original_item_total:
          oneOf:
            - type: string
              title: original_item_total
              description: The parent's original item total.
            - type: number
              title: original_item_total
              description: The parent's original item total.
            - type: string
              title: original_item_total
              description: The parent's original item total.
            - $ref: '#/components/schemas/IBigNumber'
        original_item_subtotal:
          oneOf:
            - type: string
              title: original_item_subtotal
              description: The parent's original item subtotal.
            - type: number
              title: original_item_subtotal
              description: The parent's original item subtotal.
            - type: string
              title: original_item_subtotal
              description: The parent's original item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_item_tax_total:
          oneOf:
            - type: string
              title: original_item_tax_total
              description: The parent's original item tax total.
            - type: number
              title: original_item_tax_total
              description: The parent's original item tax total.
            - type: string
              title: original_item_tax_total
              description: The parent's original item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        item_total:
          oneOf:
            - type: string
              title: item_total
              description: The parent's item total.
            - type: number
              title: item_total
              description: The parent's item total.
            - type: string
              title: item_total
              description: The parent's item total.
            - $ref: '#/components/schemas/IBigNumber'
        item_subtotal:
          oneOf:
            - type: string
              title: item_subtotal
              description: The parent's item subtotal.
            - type: number
              title: item_subtotal
              description: The parent's item subtotal.
            - type: string
              title: item_subtotal
              description: The parent's item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        item_tax_total:
          oneOf:
            - type: string
              title: item_tax_total
              description: The parent's item tax total.
            - type: number
              title: item_tax_total
              description: The parent's item tax total.
            - type: string
              title: item_tax_total
              description: The parent's item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The parent's original total.
            - type: number
              title: original_total
              description: The parent's original total.
            - type: string
              title: original_total
              description: The parent's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The parent's original subtotal.
            - type: number
              title: original_subtotal
              description: The parent's original subtotal.
            - type: string
              title: original_subtotal
              description: The parent's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The parent's original tax total.
            - type: number
              title: original_tax_total
              description: The parent's original tax total.
            - type: string
              title: original_tax_total
              description: The parent's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The parent's total.
            - type: number
              title: total
              description: The parent's total.
            - type: string
              title: total
              description: The parent's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The parent's subtotal.
            - type: number
              title: subtotal
              description: The parent's subtotal.
            - type: string
              title: subtotal
              description: The parent's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The parent's tax total.
            - type: number
              title: tax_total
              description: The parent's tax total.
            - type: string
              title: tax_total
              description: The parent's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The parent's discount total.
            - type: number
              title: discount_total
              description: The parent's discount total.
            - type: string
              title: discount_total
              description: The parent's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The parent's discount tax total.
            - type: number
              title: discount_tax_total
              description: The parent's discount tax total.
            - type: string
              title: discount_tax_total
              description: The parent's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
        gift_card_total:
          oneOf:
            - type: string
              title: gift_card_total
              description: The parent's gift card total.
            - type: number
              title: gift_card_total
              description: The parent's gift card total.
            - type: string
              title: gift_card_total
              description: The parent's gift card total.
            - $ref: '#/components/schemas/IBigNumber'
        gift_card_tax_total:
          oneOf:
            - type: string
              title: gift_card_tax_total
              description: The parent's gift card tax total.
            - type: number
              title: gift_card_tax_total
              description: The parent's gift card tax total.
            - type: string
              title: gift_card_tax_total
              description: The parent's gift card tax total.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_total:
          oneOf:
            - type: string
              title: shipping_total
              description: The parent's shipping total.
            - type: number
              title: shipping_total
              description: The parent's shipping total.
            - type: string
              title: shipping_total
              description: The parent's shipping total.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_subtotal:
          oneOf:
            - type: string
              title: shipping_subtotal
              description: The parent's shipping subtotal.
            - type: number
              title: shipping_subtotal
              description: The parent's shipping subtotal.
            - type: string
              title: shipping_subtotal
              description: The parent's shipping subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        shipping_tax_total:
          oneOf:
            - type: string
              title: shipping_tax_total
              description: The parent's shipping tax total.
            - type: number
              title: shipping_tax_total
              description: The parent's shipping tax total.
            - type: string
              title: shipping_tax_total
              description: The parent's shipping tax total.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_total:
          oneOf:
            - type: string
              title: original_shipping_total
              description: The parent's original shipping total.
            - type: number
              title: original_shipping_total
              description: The parent's original shipping total.
            - type: string
              title: original_shipping_total
              description: The parent's original shipping total.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_subtotal:
          oneOf:
            - type: string
              title: original_shipping_subtotal
              description: The parent's original shipping subtotal.
            - type: number
              title: original_shipping_subtotal
              description: The parent's original shipping subtotal.
            - type: string
              title: original_shipping_subtotal
              description: The parent's original shipping subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_shipping_tax_total:
          oneOf:
            - type: string
              title: original_shipping_tax_total
              description: The parent's original shipping tax total.
            - type: number
              title: original_shipping_tax_total
              description: The parent's original shipping tax total.
            - type: string
              title: original_shipping_tax_total
              description: The parent's original shipping tax total.
            - $ref: '#/components/schemas/IBigNumber'
    StoreCartAddress:
      type: object
      description: The cart's billing address.
      x-schemaName: StoreCartAddress
      required:
        - id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The billing address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The billing address's customer id.
        first_name:
          type: string
          title: first_name
          description: The billing address's first name.
        last_name:
          type: string
          title: last_name
          description: The billing address's last name.
        phone:
          type: string
          title: phone
          description: The billing address's phone.
        company:
          type: string
          title: company
          description: The billing address's company.
        address_1:
          type: string
          title: address_1
          description: The billing address's address 1.
        address_2:
          type: string
          title: address_2
          description: The billing address's address 2.
        city:
          type: string
          title: city
          description: The billing address's city.
        country_code:
          type: string
          title: country_code
          description: The billing address's country code.
        province:
          type: string
          title: province
          description: The billing address's province.
        postal_code:
          type: string
          title: postal_code
          description: The billing address's postal code.
        metadata:
          type: object
          description: The billing address's metadata.
        created_at:
          oneOf:
            - type: string
              title: created_at
              description: The billing address's created at.
            - type: string
              title: created_at
              description: The billing address's created at.
              format: date-time
        updated_at:
          oneOf:
            - type: string
              title: updated_at
              description: The billing address's updated at.
            - type: string
              title: updated_at
              description: The billing address's updated at.
              format: date-time
    StoreCartLineItem:
      type: object
      description: The item's items.
      x-schemaName: StoreCartLineItem
      required:
        - id
        - title
        - quantity
        - requires_shipping
        - is_discountable
        - is_tax_inclusive
        - unit_price
        - cart
        - cart_id
        - original_total
        - original_subtotal
        - original_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
      properties:
        id:
          type: string
          title: id
          description: The item's ID.
        title:
          type: string
          title: title
          description: The item's title.
        subtitle:
          type: string
          title: subtitle
          description: The item's subtitle.
        thumbnail:
          type: string
          title: thumbnail
          description: The item's thumbnail.
        quantity:
          oneOf:
            - type: string
              title: quantity
              description: The item's quantity.
            - type: number
              title: quantity
              description: The item's quantity.
            - type: string
              title: quantity
              description: The item's quantity.
            - $ref: '#/components/schemas/IBigNumber'
        product:
          $ref: '#/components/schemas/BaseProduct'
        product_id:
          type: string
          title: product_id
          description: The item's product id.
        product_title:
          type: string
          title: product_title
          description: The item's product title.
        product_description:
          type: string
          title: product_description
          description: The item's product description.
        product_subtitle:
          type: string
          title: product_subtitle
          description: The item's product subtitle.
        product_type:
          type: string
          title: product_type
          description: The item's product type.
        product_collection:
          type: string
          title: product_collection
          description: The item's product collection.
        product_handle:
          type: string
          title: product_handle
          description: The item's product handle.
        variant:
          $ref: '#/components/schemas/BaseProductVariant'
        variant_id:
          type: string
          title: variant_id
          description: The item's variant id.
        variant_sku:
          type: string
          title: variant_sku
          description: The item's variant sku.
        variant_barcode:
          type: string
          title: variant_barcode
          description: The item's variant barcode.
        variant_title:
          type: string
          title: variant_title
          description: The item's variant title.
        variant_option_values:
          type: object
          description: The item's variant option values.
        requires_shipping:
          type: boolean
          title: requires_shipping
          description: The item's requires shipping.
        is_discountable:
          type: boolean
          title: is_discountable
          description: The item's is discountable.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The item's is tax inclusive.
        compare_at_unit_price:
          oneOf:
            - type: string
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - type: number
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - type: string
              title: compare_at_unit_price
              description: The item's compare at unit price.
            - $ref: '#/components/schemas/IBigNumber'
        unit_price:
          oneOf:
            - type: string
              title: unit_price
              description: The item's unit price.
            - type: number
              title: unit_price
              description: The item's unit price.
            - type: string
              title: unit_price
              description: The item's unit price.
            - $ref: '#/components/schemas/IBigNumber'
        tax_lines:
          type: array
          description: The item's tax lines.
          items:
            $ref: '#/components/schemas/BaseLineItemTaxLine'
        adjustments:
          type: array
          description: The item's adjustments.
          items:
            $ref: '#/components/schemas/BaseLineItemAdjustment'
        cart:
          $ref: '#/components/schemas/BaseCart'
        cart_id:
          type: string
          title: cart_id
          description: The item's cart id.
        metadata:
          type: object
          description: The item's metadata.
        created_at:
          type: string
          title: created_at
          description: The item's created at.
          format: date-time
        updated_at:
          type: string
          title: updated_at
          description: The item's updated at.
          format: date-time
        deleted_at:
          type: string
          title: deleted_at
          description: The item's deleted at.
          format: date-time
        original_total:
          oneOf:
            - type: string
              title: original_total
              description: The item's original total.
            - type: number
              title: original_total
              description: The item's original total.
            - type: string
              title: original_total
              description: The item's original total.
            - $ref: '#/components/schemas/IBigNumber'
        original_subtotal:
          oneOf:
            - type: string
              title: original_subtotal
              description: The item's original subtotal.
            - type: number
              title: original_subtotal
              description: The item's original subtotal.
            - type: string
              title: original_subtotal
              description: The item's original subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        original_tax_total:
          oneOf:
            - type: string
              title: original_tax_total
              description: The item's original tax total.
            - type: number
              title: original_tax_total
              description: The item's original tax total.
            - type: string
              title: original_tax_total
              description: The item's original tax total.
            - $ref: '#/components/schemas/IBigNumber'
        item_total:
          oneOf:
            - type: string
              title: item_total
              description: The item's item total.
            - type: number
              title: item_total
              description: The item's item total.
            - type: string
              title: item_total
              description: The item's item total.
            - $ref: '#/components/schemas/IBigNumber'
        item_subtotal:
          oneOf:
            - type: string
              title: item_subtotal
              description: The item's item subtotal.
            - type: number
              title: item_subtotal
              description: The item's item subtotal.
            - type: string
              title: item_subtotal
              description: The item's item subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        item_tax_total:
          oneOf:
            - type: string
              title: item_tax_total
              description: The item's item tax total.
            - type: number
              title: item_tax_total
              description: The item's item tax total.
            - type: string
              title: item_tax_total
              description: The item's item tax total.
            - $ref: '#/components/schemas/IBigNumber'
        total:
          oneOf:
            - type: string
              title: total
              description: The item's total.
            - type: number
              title: total
              description: The item's total.
            - type: string
              title: total
              description: The item's total.
            - $ref: '#/components/schemas/IBigNumber'
        subtotal:
          oneOf:
            - type: string
              title: subtotal
              description: The item's subtotal.
            - type: number
              title: subtotal
              description: The item's subtotal.
            - type: string
              title: subtotal
              description: The item's subtotal.
            - $ref: '#/components/schemas/IBigNumber'
        tax_total:
          oneOf:
            - type: string
              title: tax_total
              description: The item's tax total.
            - type: number
              title: tax_total
              description: The item's tax total.
            - type: string
              title: tax_total
              description: The item's tax total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_total:
          oneOf:
            - type: string
              title: discount_total
              description: The item's discount total.
            - type: number
              title: discount_total
              description: The item's discount total.
            - type: string
              title: discount_total
              description: The item's discount total.
            - $ref: '#/components/schemas/IBigNumber'
        discount_tax_total:
          oneOf:
            - type: string
              title: discount_tax_total
              description: The item's discount tax total.
            - type: number
              title: discount_tax_total
              description: The item's discount tax total.
            - type: string
              title: discount_tax_total
              description: The item's discount tax total.
            - $ref: '#/components/schemas/IBigNumber'
    StoreCartResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCartResponse
      required:
        - cart
      properties:
        cart:
          $ref: '#/components/schemas/StoreCart'
    StoreCollection:
      type: object
      description: The collection's details.
      x-schemaName: StoreCollection
      required:
        - id
        - title
        - handle
        - created_at
        - updated_at
        - deleted_at
        - metadata
      properties:
        id:
          type: string
          title: id
          description: The collection's ID.
        title:
          type: string
          title: title
          description: The collection's title.
        handle:
          type: string
          title: handle
          description: The collection's handle.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The collection's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The collection's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The collection's deleted at.
        products:
          type: array
          description: The collection's products.
          items:
            $ref: '#/components/schemas/AdminProduct'
        metadata:
          type: object
          description: The collection's metadata.
    StoreCollectionResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCollectionResponse
      required:
        - collection
      properties:
        collection:
          $ref: '#/components/schemas/StoreCollection'
    StoreCreateCart:
      type: object
      description: SUMMARY
      x-schemaName: StoreCreateCart
      properties:
        region_id:
          type: string
          title: region_id
          description: The cart's region id.
        shipping_address:
          $ref: '#/components/schemas/StoreCartAddress'
        billing_address:
          $ref: '#/components/schemas/StoreCartAddress'
        email:
          type: string
          title: email
          description: The cart's email.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The cart's currency code.
        items:
          type: array
          description: The cart's items.
          items:
            $ref: '#/components/schemas/StoreCartLineItem'
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The cart's sales channel id.
        metadata:
          type: object
          description: The cart's metadata.
    StoreCreateCustomer:
      type: object
      description: SUMMARY
      x-schemaName: StoreCreateCustomer
      required:
        - email
      properties:
        email:
          type: string
          title: email
          description: The customer's email.
          format: email
        company_name:
          type: string
          title: company_name
          description: The customer's company name.
        first_name:
          type: string
          title: first_name
          description: The customer's first name.
        last_name:
          type: string
          title: last_name
          description: The customer's last name.
        phone:
          type: string
          title: phone
          description: The customer's phone.
        metadata:
          type: object
          description: The customer's metadata.
    StoreCreatePaymentCollection:
      type: object
      description: SUMMARY
      x-schemaName: StoreCreatePaymentCollection
      required:
        - cart_id
      properties:
        cart_id:
          type: string
          title: cart_id
          description: The payment collection's cart id.
    StoreCreateReturn:
      type: object
      description: SUMMARY
      x-schemaName: StoreCreateReturn
      required:
        - order_id
        - items
        - return_shipping
      properties:
        order_id:
          type: string
          title: order_id
          description: The return's order id.
        items:
          type: array
          description: The return's items.
          items:
            $ref: '#/components/schemas/StoreCreateReturnItem'
        return_shipping:
          $ref: '#/components/schemas/StoreCreateReturnShipping'
        note:
          type: string
          title: note
          description: The return's note.
        receive_now:
          type: boolean
          title: receive_now
          description: The return's receive now.
        location_id:
          type: string
          title: location_id
          description: The return's location id.
    StoreCreateReturnItem:
      type: object
      description: The item's items.
      x-schemaName: StoreCreateReturnItem
      required:
        - id
        - quantity
      properties:
        id:
          type: string
          title: id
          description: The item's ID.
        quantity:
          type: number
          title: quantity
          description: The item's quantity.
        reason_id:
          type: string
          title: reason_id
          description: The item's reason id.
        note:
          type: string
          title: note
          description: The item's note.
    StoreCreateReturnShipping:
      type: object
      description: The return's return shipping.
      x-schemaName: StoreCreateReturnShipping
      required:
        - option_id
      properties:
        option_id:
          type: string
          title: option_id
          description: The return shipping's option id.
        price:
          type: number
          title: price
          description: The return shipping's price.
    StoreCurrency:
      type: object
      description: The currency's details.
      x-schemaName: StoreCurrency
      required:
        - code
        - symbol
        - symbol_native
        - name
        - decimal_digits
        - rounding
        - raw_rounding
        - created_at
        - updated_at
        - deleted_at
      properties:
        code:
          type: string
          title: code
          description: The currency's code.
        symbol:
          type: string
          title: symbol
          description: The currency's symbol.
        symbol_native:
          type: string
          title: symbol_native
          description: The currency's symbol native.
        name:
          type: string
          title: name
          description: The currency's name.
        decimal_digits:
          type: number
          title: decimal_digits
          description: The currency's decimal digits.
        rounding:
          type: number
          title: rounding
          description: The currency's rounding.
        raw_rounding:
          type: object
          description: The currency's raw rounding.
          required:
            - value
            - precision
          properties:
            value:
              type: string
              title: value
              description: The raw rounding's value.
            precision:
              type: number
              title: precision
              description: The raw rounding's precision.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The currency's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The currency's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The currency's deleted at.
    StoreCurrencyListResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCurrencyListResponse
      required:
        - limit
        - offset
        - count
        - currencies
      properties:
        limit:
          type: number
          title: limit
          description: The currency's limit.
        offset:
          type: number
          title: offset
          description: The currency's offset.
        count:
          type: number
          title: count
          description: The currency's count.
        currencies:
          type: array
          description: The currency's currencies.
          items:
            $ref: '#/components/schemas/StoreCurrency'
    StoreCurrencyResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCurrencyResponse
      required:
        - currency
      properties:
        currency:
          $ref: '#/components/schemas/StoreCurrency'
    StoreCustomer:
      type: object
      description: The customer's parent.
      x-schemaName: StoreCustomer
      required:
        - id
        - email
        - default_billing_address_id
        - default_shipping_address_id
        - company_name
        - first_name
        - last_name
        - addresses
      properties:
        id:
          type: string
          title: id
          description: The parent's ID.
        email:
          type: string
          title: email
          description: The parent's email.
          format: email
        default_billing_address_id:
          type: string
          title: default_billing_address_id
          description: The parent's default billing address id.
        default_shipping_address_id:
          type: string
          title: default_shipping_address_id
          description: The parent's default shipping address id.
        company_name:
          type: string
          title: company_name
          description: The parent's company name.
        first_name:
          type: string
          title: first_name
          description: The parent's first name.
        last_name:
          type: string
          title: last_name
          description: The parent's last name.
        addresses:
          type: array
          description: The parent's addresses.
          items:
            $ref: '#/components/schemas/BaseCustomerAddress'
        phone:
          type: string
          title: phone
          description: The parent's phone.
        metadata:
          type: object
          description: The parent's metadata.
        created_by:
          type: string
          title: created_by
          description: The parent's created by.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The parent's deleted at.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The parent's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The parent's updated at.
    StoreCustomerAddress:
      type: object
      description: The customer's address.
      x-schemaName: StoreCustomerAddress
      required:
        - id
        - address_name
        - is_default_shipping
        - is_default_billing
        - customer_id
        - company
        - first_name
        - last_name
        - address_1
        - address_2
        - city
        - country_code
        - province
        - postal_code
        - phone
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The address's ID.
        address_name:
          type: string
          title: address_name
          description: The address's address name.
        is_default_shipping:
          type: boolean
          title: is_default_shipping
          description: The address's is default shipping.
        is_default_billing:
          type: boolean
          title: is_default_billing
          description: The address's is default billing.
        customer_id:
          type: string
          title: customer_id
          description: The address's customer id.
        company:
          type: string
          title: company
          description: The address's company.
        first_name:
          type: string
          title: first_name
          description: The address's first name.
        last_name:
          type: string
          title: last_name
          description: The address's last name.
        address_1:
          type: string
          title: address_1
          description: The address's address 1.
        address_2:
          type: string
          title: address_2
          description: The address's address 2.
        city:
          type: string
          title: city
          description: The address's city.
        country_code:
          type: string
          title: country_code
          description: The address's country code.
        province:
          type: string
          title: province
          description: The address's province.
        postal_code:
          type: string
          title: postal_code
          description: The address's postal code.
        phone:
          type: string
          title: phone
          description: The address's phone.
        metadata:
          type: object
          description: The address's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The address's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The address's updated at.
    StoreCustomerAddressListResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCustomerAddressListResponse
      required:
        - limit
        - offset
        - count
        - addresses
      properties:
        limit:
          type: number
          title: limit
          description: The customer's limit.
        offset:
          type: number
          title: offset
          description: The customer's offset.
        count:
          type: number
          title: count
          description: The customer's count.
        addresses:
          type: array
          description: The customer's addresses.
          items:
            $ref: '#/components/schemas/StoreCustomerAddress'
    StoreCustomerAddressResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCustomerAddressResponse
      required:
        - address
      properties:
        address:
          $ref: '#/components/schemas/StoreCustomerAddress'
    StoreCustomerResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreCustomerResponse
      required:
        - customer
      properties:
        customer:
          $ref: '#/components/schemas/StoreCustomer'
    StoreOrder:
      type: object
      description: The cart's order.
      x-schemaName: StoreOrder
      required:
        - id
        - version
        - region_id
        - customer_id
        - sales_channel_id
        - email
        - currency_code
        - items
        - shipping_methods
        - payment_status
        - fulfillment_status
        - summary
        - metadata
        - created_at
        - updated_at
        - original_item_total
        - original_item_subtotal
        - original_item_tax_total
        - item_total
        - item_subtotal
        - item_tax_total
        - original_total
        - original_subtotal
        - original_tax_total
        - total
        - subtotal
        - tax_total
        - discount_total
        - discount_tax_total
        - gift_card_total
        - gift_card_tax_total
        - shipping_total
        - shipping_subtotal
        - shipping_tax_total
        - original_shipping_total
        - original_shipping_subtotal
        - original_shipping_tax_total
      properties:
        id:
          type: string
          title: id
          description: The order's ID.
        version:
          type: number
          title: version
          description: The order's version.
        region_id:
          type: string
          title: region_id
          description: The order's region id.
        customer_id:
          type: string
          title: customer_id
          description: The order's customer id.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The order's sales channel id.
        email:
          type: string
          title: email
          description: The order's email.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The order's currency code.
        display_id:
          type: number
          title: display_id
          description: The order's display id.
        shipping_address:
          $ref: '#/components/schemas/BaseOrderAddress'
        billing_address:
          $ref: '#/components/schemas/BaseOrderAddress'
        items:
          type: array
          description: The order's items.
          items:
            $ref: '#/components/schemas/BaseOrderLineItem'
        shipping_methods:
          type: array
          description: The order's shipping methods.
          items:
            $ref: '#/components/schemas/BaseOrderShippingMethod'
        payment_collections:
          type: array
          description: The order's payment collections.
          items:
            $ref: '#/components/schemas/BasePaymentCollection'
        payment_status:
          type: string
          description: The order's payment status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
            - captured
            - partially_captured
            - partially_refunded
            - refunded
            - requires_action
        fulfillments:
          type: array
          description: The order's fulfillments.
          items:
            $ref: '#/components/schemas/BaseOrderFulfillment'
        fulfillment_status:
          type: string
          description: The order's fulfillment status.
          enum:
            - canceled
            - not_fulfilled
            - partially_fulfilled
            - fulfilled
            - partially_shipped
            - shipped
            - partially_delivered
            - delivered
        transactions:
          type: array
          description: The order's transactions.
          items:
            $ref: '#/components/schemas/BaseOrderTransaction'
        summary:
          $ref: '#/components/schemas/BaseOrderSummary'
        metadata:
          type: object
          description: The order's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The order's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The order's updated at.
        original_item_total:
          type: number
          title: original_item_total
          description: The order's original item total.
        original_item_subtotal:
          type: number
          title: original_item_subtotal
          description: The order's original item subtotal.
        original_item_tax_total:
          type: number
          title: original_item_tax_total
          description: The order's original item tax total.
        item_total:
          type: number
          title: item_total
          description: The order's item total.
        item_subtotal:
          type: number
          title: item_subtotal
          description: The order's item subtotal.
        item_tax_total:
          type: number
          title: item_tax_total
          description: The order's item tax total.
        original_total:
          type: number
          title: original_total
          description: The order's original total.
        original_subtotal:
          type: number
          title: original_subtotal
          description: The order's original subtotal.
        original_tax_total:
          type: number
          title: original_tax_total
          description: The order's original tax total.
        total:
          type: number
          title: total
          description: The order's total.
        subtotal:
          type: number
          title: subtotal
          description: The order's subtotal.
        tax_total:
          type: number
          title: tax_total
          description: The order's tax total.
        discount_total:
          type: number
          title: discount_total
          description: The order's discount total.
        discount_tax_total:
          type: number
          title: discount_tax_total
          description: The order's discount tax total.
        gift_card_total:
          type: number
          title: gift_card_total
          description: The order's gift card total.
        gift_card_tax_total:
          type: number
          title: gift_card_tax_total
          description: The order's gift card tax total.
        shipping_total:
          type: number
          title: shipping_total
          description: The order's shipping total.
        shipping_subtotal:
          type: number
          title: shipping_subtotal
          description: The order's shipping subtotal.
        shipping_tax_total:
          type: number
          title: shipping_tax_total
          description: The order's shipping tax total.
        original_shipping_total:
          type: number
          title: original_shipping_total
          description: The order's original shipping total.
        original_shipping_subtotal:
          type: number
          title: original_shipping_subtotal
          description: The order's original shipping subtotal.
        original_shipping_tax_total:
          type: number
          title: original_shipping_tax_total
          description: The order's original shipping tax total.
    StoreOrderResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreOrderResponse
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/StoreOrder'
    StorePaymentCollection:
      type: object
      description: The payment collection's details.
      x-schemaName: StorePaymentCollection
      required:
        - id
        - currency_code
        - region_id
        - amount
        - status
        - payment_providers
      properties:
        id:
          type: string
          title: id
          description: The payment collection's ID.
        currency_code:
          type: string
          title: currency_code
          description: The payment collection's currency code.
        region_id:
          type: string
          title: region_id
          description: The payment collection's region id.
        amount:
          oneOf:
            - type: string
              title: amount
              description: The payment collection's amount.
            - type: number
              title: amount
              description: The payment collection's amount.
            - type: string
              title: amount
              description: The payment collection's amount.
            - $ref: '#/components/schemas/IBigNumber'
        authorized_amount:
          oneOf:
            - type: string
              title: authorized_amount
              description: The payment collection's authorized amount.
            - type: number
              title: authorized_amount
              description: The payment collection's authorized amount.
            - type: string
              title: authorized_amount
              description: The payment collection's authorized amount.
            - $ref: '#/components/schemas/IBigNumber'
        captured_amount:
          oneOf:
            - type: string
              title: captured_amount
              description: The payment collection's captured amount.
            - type: number
              title: captured_amount
              description: The payment collection's captured amount.
            - type: string
              title: captured_amount
              description: The payment collection's captured amount.
            - $ref: '#/components/schemas/IBigNumber'
        refunded_amount:
          oneOf:
            - type: string
              title: refunded_amount
              description: The payment collection's refunded amount.
            - type: number
              title: refunded_amount
              description: The payment collection's refunded amount.
            - type: string
              title: refunded_amount
              description: The payment collection's refunded amount.
            - $ref: '#/components/schemas/IBigNumber'
        completed_at:
          oneOf:
            - type: string
              title: completed_at
              description: The payment collection's completed at.
            - type: string
              title: completed_at
              description: The payment collection's completed at.
              format: date-time
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The payment collection's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The payment collection's updated at.
        metadata:
          type: object
          description: The payment collection's metadata.
        status:
          type: string
          description: The payment collection's status.
          enum:
            - canceled
            - not_paid
            - awaiting
            - authorized
            - partially_authorized
        payment_providers:
          type: array
          description: The payment collection's payment providers.
          items:
            $ref: '#/components/schemas/BasePaymentProvider'
        payment_sessions:
          type: array
          description: The payment collection's payment sessions.
          items:
            $ref: '#/components/schemas/BasePaymentSession'
        payments:
          type: array
          description: The payment collection's payments.
          items:
            $ref: '#/components/schemas/BasePayment'
    StorePaymentCollectionResponse:
      type: object
      description: SUMMARY
      x-schemaName: StorePaymentCollectionResponse
      required:
        - payment_collection
      properties:
        payment_collection:
          $ref: '#/components/schemas/StorePaymentCollection'
    StorePaymentProvider:
      type: object
      description: The payment provider's payment providers.
      x-schemaName: StorePaymentProvider
      required:
        - id
      properties:
        id:
          type: string
          title: id
          description: The payment provider's ID.
    StoreProduct:
      type: object
      description: The product's details.
      x-schemaName: StoreProduct
      required:
        - length
        - title
        - status
        - options
        - description
        - id
        - created_at
        - updated_at
        - variants
        - handle
        - subtitle
        - is_giftcard
        - thumbnail
        - width
        - weight
        - height
        - origin_country
        - hs_code
        - mid_code
        - material
        - collection_id
        - type_id
        - images
        - discountable
        - external_id
        - deleted_at
      properties:
        categories:
          type: array
          description: The product's categories.
          items:
            type: object
        type:
          type: object
        length:
          type: number
          title: length
          description: The product's length.
        title:
          type: string
          title: title
          description: The product's title.
        status:
          type: string
          description: The product's status.
          enum:
            - draft
            - proposed
            - published
            - rejected
        options:
          type: array
          description: The product's options.
          items:
            $ref: '#/components/schemas/BaseProductOption'
        description:
          type: string
          title: description
          description: The product's description.
        id:
          type: string
          title: id
          description: The product's ID.
        metadata:
          type: object
          description: The product's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The product's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The product's updated at.
        variants:
          type: array
          description: The product's variants.
          items:
            $ref: '#/components/schemas/BaseProductVariant'
        handle:
          type: string
          title: handle
          description: The product's handle.
        subtitle:
          type: string
          title: subtitle
          description: The product's subtitle.
        is_giftcard:
          type: boolean
          title: is_giftcard
          description: The product's is giftcard.
        thumbnail:
          type: string
          title: thumbnail
          description: The product's thumbnail.
        width:
          type: number
          title: width
          description: The product's width.
        weight:
          type: number
          title: weight
          description: The product's weight.
        height:
          type: number
          title: height
          description: The product's height.
        origin_country:
          type: string
          title: origin_country
          description: The product's origin country.
        hs_code:
          type: string
          title: hs_code
          description: The product's hs code.
        mid_code:
          type: string
          title: mid_code
          description: The product's mid code.
        material:
          type: string
          title: material
          description: The product's material.
        collection:
          $ref: '#/components/schemas/BaseCollection'
        collection_id:
          type: string
          title: collection_id
          description: The product's collection id.
        type_id:
          type: string
          title: type_id
          description: The product's type id.
        tags:
          type: array
          description: The product's tags.
          items:
            $ref: '#/components/schemas/BaseProductTag'
        images:
          type: array
          description: The product's images.
          items:
            $ref: '#/components/schemas/BaseProductImage'
        discountable:
          type: boolean
          title: discountable
          description: The product's discountable.
        external_id:
          type: string
          title: external_id
          description: The product's external id.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The product's deleted at.
    StoreProductCategory:
      type: object
      description: The category's categories.
      x-schemaName: StoreProductCategory
      required:
        - id
        - name
        - description
        - handle
        - is_active
        - is_internal
        - rank
        - parent_category_id
        - parent_category
        - category_children
        - created_at
        - updated_at
        - deleted_at
      properties:
        products:
          type: array
          description: The category's products.
          items:
            $ref: '#/components/schemas/StoreProduct'
        id:
          type: string
          title: id
          description: The category's ID.
        name:
          type: string
          title: name
          description: The category's name.
        description:
          type: string
          title: description
          description: The category's description.
        handle:
          type: string
          title: handle
          description: The category's handle.
        is_active:
          type: boolean
          title: is_active
          description: The category's is active.
        is_internal:
          type: boolean
          title: is_internal
          description: The category's is internal.
        rank:
          type: number
          title: rank
          description: The category's rank.
        parent_category_id:
          type: string
          title: parent_category_id
          description: The category's parent category id.
        parent_category:
          $ref: '#/components/schemas/BaseProductCategory'
        category_children:
          type: array
          description: The category's category children.
          items:
            $ref: '#/components/schemas/BaseProductCategory'
        metadata:
          type: object
          description: The category's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The category's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The category's updated at.
        deleted_at:
          type: string
          format: date-time
          title: deleted_at
          description: The category's deleted at.
    StoreProductCategoryListResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreProductCategoryListResponse
      required:
        - limit
        - offset
        - count
        - product_categories
      properties:
        limit:
          type: number
          title: limit
          description: The product category's limit.
        offset:
          type: number
          title: offset
          description: The product category's offset.
        count:
          type: number
          title: count
          description: The product category's count.
        product_categories:
          type: array
          description: The product category's product categories.
          items:
            $ref: '#/components/schemas/StoreProductCategory'
    StoreProductCategoryResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreProductCategoryResponse
      required:
        - product_category
      properties:
        product_category:
          $ref: '#/components/schemas/StoreProductCategory'
    StoreProductResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreProductResponse
      required:
        - product
      properties:
        product:
          $ref: '#/components/schemas/StoreProduct'
    StoreProductVariantParams:
      type: object
      description: The product's variants.
      x-schemaName: StoreProductVariantParams
      properties:
        q:
          type: string
          title: q
          description: The variant's q.
        id:
          oneOf:
            - type: string
              title: id
              description: The variant's ID.
            - type: array
              description: The variant's ID.
              items:
                type: string
                title: id
                description: The id's ID.
        sku:
          oneOf:
            - type: string
              title: sku
              description: The variant's sku.
            - type: array
              description: The variant's sku.
              items:
                type: string
                title: sku
                description: The sku's details.
        product_id:
          oneOf:
            - type: string
              title: product_id
              description: The variant's product id.
            - type: array
              description: The variant's product id.
              items:
                type: string
                title: product_id
                description: The product id's details.
        options:
          type: object
          description: The variant's options.
        limit:
          type: number
          title: limit
          description: The variant's limit.
        offset:
          type: number
          title: offset
          description: The variant's offset.
        order:
          type: string
          title: order
          description: The variant's order.
        fields:
          type: string
          title: fields
          description: The variant's fields.
        $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
    StoreRegion:
      type: object
      description: The region's details.
      x-schemaName: StoreRegion
      required:
        - id
        - name
        - currency_code
      properties:
        id:
          type: string
          title: id
          description: The region's ID.
        name:
          type: string
          title: name
          description: The region's name.
        currency_code:
          type: string
          title: currency_code
          description: The region's currency code.
        automatic_taxes:
          type: boolean
          title: automatic_taxes
          description: The region's automatic taxes.
        countries:
          type: array
          description: The region's countries.
          items:
            $ref: '#/components/schemas/BaseRegionCountry'
        payment_providers:
          type: array
          description: The region's payment providers.
          items:
            $ref: '#/components/schemas/AdminPaymentProvider'
        metadata:
          type: object
          description: The region's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The region's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The region's updated at.
    StoreReturn:
      type: object
      description: The return's details.
      x-schemaName: StoreReturn
      required:
        - id
        - order_id
        - order_version
        - display_id
        - items
        - received_at
        - created_at
        - canceled_at
      properties:
        id:
          type: string
          title: id
          description: The return's ID.
        order_id:
          type: string
          title: order_id
          description: The return's order id.
        status:
          type: string
          title: status
          description: The return's status.
        exchange_id:
          type: string
          title: exchange_id
          description: The return's exchange id.
        location_id:
          type: string
          title: location_id
          description: The return's location id.
        claim_id:
          type: string
          title: claim_id
          description: The return's claim id.
        order_version:
          type: number
          title: order_version
          description: The return's order version.
        display_id:
          type: number
          title: display_id
          description: The return's display id.
        no_notification:
          type: boolean
          title: no_notification
          description: The return's no notification.
        refund_amount:
          type: number
          title: refund_amount
          description: The return's refund amount.
        items:
          type: array
          description: The return's items.
          items:
            $ref: '#/components/schemas/BaseReturnItem'
        received_at:
          type: string
          title: received_at
          description: The return's received at.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The return's created at.
        canceled_at:
          type: string
          title: canceled_at
          description: The return's canceled at.
    StoreReturnReason:
      type: object
      description: The return reason's details.
      x-schemaName: StoreReturnReason
      required:
        - id
        - value
        - label
        - created_at
        - updated_at
      properties:
        id:
          type: string
          title: id
          description: The return reason's ID.
        value:
          type: string
          title: value
          description: The return reason's value.
        label:
          type: string
          title: label
          description: The return reason's label.
        description:
          type: string
          title: description
          description: The return reason's description.
        metadata:
          type: object
          description: The return reason's metadata.
        created_at:
          type: string
          format: date-time
          title: created_at
          description: The return reason's created at.
        updated_at:
          type: string
          format: date-time
          title: updated_at
          description: The return reason's updated at.
    StoreReturnReasonResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreReturnReasonResponse
      required:
        - return_reason
      properties:
        return_reason:
          $ref: '#/components/schemas/StoreReturnReason'
    StoreReturnResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreReturnResponse
      required:
        - return
      properties:
        return:
          $ref: '#/components/schemas/StoreReturn'
    StoreShippingOption:
      type: object
      description: The shipping option's shipping options.
      x-schemaName: StoreShippingOption
      required:
        - id
        - name
        - price_type
        - service_zone_id
        - provider_id
        - provider
        - shipping_option_type_id
        - type
        - shipping_profile_id
        - amount
        - is_tax_inclusive
        - data
        - metadata
      properties:
        id:
          type: string
          title: id
          description: The shipping option's ID.
        name:
          type: string
          title: name
          description: The shipping option's name.
        price_type:
          type: string
          description: The shipping option's price type.
          enum:
            - flat
            - calculated
        service_zone_id:
          type: string
          title: service_zone_id
          description: The shipping option's service zone id.
        provider_id:
          type: string
          title: provider_id
          description: The shipping option's provider id.
        provider:
          $ref: '#/components/schemas/BaseFulfillmentProvider'
        shipping_option_type_id:
          type: string
          title: shipping_option_type_id
          description: The shipping option's shipping option type id.
        type:
          type: object
        shipping_profile_id:
          type: string
          title: shipping_profile_id
          description: The shipping option's shipping profile id.
        amount:
          type: number
          title: amount
          description: The shipping option's amount.
        is_tax_inclusive:
          type: boolean
          title: is_tax_inclusive
          description: The shipping option's is tax inclusive.
        data:
          type: object
          description: The shipping option's data.
        metadata:
          type: object
          description: The shipping option's metadata.
    StoreShippingOptionListResponse:
      type: object
      description: SUMMARY
      x-schemaName: StoreShippingOptionListResponse
      required:
        - shipping_options
      properties:
        shipping_options:
          type: array
          description: The shipping option's shipping options.
          items:
            $ref: '#/components/schemas/StoreShippingOption'
    StoreUpdateCartLineItem:
      type: object
      description: SUMMARY
      x-schemaName: StoreUpdateCartLineItem
      required:
        - quantity
      properties:
        quantity:
          type: number
          title: quantity
          description: The cart's quantity.
        metadata:
          type: object
          description: The cart's metadata.
    StoreUpdateCustomer:
      type: object
      description: SUMMARY
      x-schemaName: StoreUpdateCustomer
      properties:
        company_name:
          type: string
          title: company_name
          description: The customer's company name.
        first_name:
          type: string
          title: first_name
          description: The customer's first name.
        last_name:
          type: string
          title: last_name
          description: The customer's last name.
        phone:
          type: string
          title: phone
          description: The customer's phone.
    UpdateAddress:
      type: object
      description: The cart's shipping address.
      x-schemaName: UpdateAddress
      required:
        - id
      properties:
        id:
          type: string
          title: id
          description: The shipping address's ID.
        customer_id:
          type: string
          title: customer_id
          description: The shipping address's customer id.
        company:
          type: string
          title: company
          description: The shipping address's company.
        first_name:
          type: string
          title: first_name
          description: The shipping address's first name.
        last_name:
          type: string
          title: last_name
          description: The shipping address's last name.
        address_1:
          type: string
          title: address_1
          description: The shipping address's address 1.
        address_2:
          type: string
          title: address_2
          description: The shipping address's address 2.
        city:
          type: string
          title: city
          description: The shipping address's city.
        country_code:
          type: string
          title: country_code
          description: The shipping address's country code.
        province:
          type: string
          title: province
          description: The shipping address's province.
        postal_code:
          type: string
          title: postal_code
          description: The shipping address's postal code.
        phone:
          type: string
          title: phone
          description: The shipping address's phone.
        metadata:
          type: object
          description: The shipping address's metadata.
    UpdateCartData:
      type: object
      description: SUMMARY
      x-schemaName: UpdateCartData
      properties:
        region_id:
          type: string
          title: region_id
          description: The cart's region id.
        customer_id:
          type: string
          title: customer_id
          description: The cart's customer id.
        sales_channel_id:
          type: string
          title: sales_channel_id
          description: The cart's sales channel id.
        email:
          type: string
          title: email
          description: The cart's email.
          format: email
        currency_code:
          type: string
          title: currency_code
          description: The cart's currency code.
        shipping_address_id:
          type: string
          title: shipping_address_id
          description: The cart's shipping address id.
        billing_address_id:
          type: string
          title: billing_address_id
          description: The cart's billing address id.
        billing_address:
          oneOf:
            - $ref: '#/components/schemas/CreateAddress'
            - $ref: '#/components/schemas/UpdateAddress'
        shipping_address:
          oneOf:
            - $ref: '#/components/schemas/CreateAddress'
            - $ref: '#/components/schemas/UpdateAddress'
        metadata:
          type: object
          description: The cart's metadata.
    UpdateOrderReturnReason:
      type: object
      description: SUMMARY
      x-schemaName: UpdateOrderReturnReason
      properties:
        id:
          type: string
          title: id
          description: The return reason's ID.
        label:
          type: string
          title: label
          description: The return reason's label.
        value:
          type: string
          title: value
          description: The return reason's value.
        description:
          type: string
          title: description
          description: The return reason's description.
        metadata:
          type: object
          description: The return reason's metadata.
    WorkflowExecutionContext:
      type: object
      description: The workflow execution's context.
      x-schemaName: WorkflowExecutionContext
      required:
        - compensate
        - errors
      properties:
        data:
          type: object
          description: The context's data.
        compensate:
          type: object
          description: The context's compensate.
        errors:
          type: array
          description: The context's errors.
          items:
            type: object
            description: The error's errors.
  responses:
    default_error:
      description: Default Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unknown_error
            message: An unknown error occurred.
            type: unknown_error
    invalid_state_error:
      description: Invalid State Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: unknown_error
            message: The request conflicted with another request. You may retry the request with the provided Idempotency-Key.
            type: QueryRunnerAlreadyReleasedError
    invalid_request_error:
      description: Invalid Request Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: invalid_request_error
            message: Discount with code TEST already exists.
            type: duplicate_error
    not_found_error:
      description: Not Found Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Entity with id 1 was not found
            type: not_found
    400_error:
      description: Client Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            not_allowed:
              $ref: '#/components/examples/not_allowed_error'
            invalid_data:
              $ref: '#/components/examples/invalid_data_error'
    500_error:
      description: Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            database:
              $ref: '#/components/examples/database_error'
            unexpected_state:
              $ref: '#/components/examples/unexpected_state_error'
            invalid_argument:
              $ref: '#/components/examples/invalid_argument_error'
            default_error:
              $ref: '#/components/examples/default_error'
    unauthorized:
      description: User is not authorized. Must log in first
      content:
        text/plain:
          schema:
            type: string
            default: Unauthorized
            example: Unauthorized
    incorrect_credentials:
      description: User does not exist or incorrect credentials
      content:
        text/plain:
          schema:
            type: string
            default: Unauthorized
            example: Unauthorized
  examples:
    not_allowed_error:
      summary: Not Allowed Error
      value:
        message: Discount must be set to dynamic
        type: not_allowed
    invalid_data_error:
      summary: Invalid Data Error
      value:
        message: first_name must be a string
        type: invalid_data
    multiple_errors:
      summary: Multiple Errors
      value:
        message: Provided request body contains errors. Please check the data and retry the request
        errors:
          - message: first_name must be a string
            type: invalid_data
          - message: Discount must be set to dynamic
            type: not_allowed
    database_error:
      summary: Database Error
      value:
        code: api_error
        message: An error occured while hashing password
        type: database_error
    unexpected_state_error:
      summary: Unexpected State Error
      value:
        message: cart.total must be defined
        type: unexpected_state
    invalid_argument_error:
      summary: Invalid Argument Error
      value:
        message: cart.total must be defined
        type: unexpected_state
    default_error:
      summary: Default Error
      value:
        code: unknown_error
        message: An unknown error occurred.
        type: unknown_error
  securitySchemes:
    jwt_token:
      type: http
      x-displayName: JWT Token
      scheme: bearer
    cookie_auth:
      type: apiKey
      x-displayName: Cookie Session ID
      in: cookie
      name: connect.sid